Posts Tagged: JSON

Should You Design Natural Language First APIs?

Humans are getting lazier, but APIs tend to stay pretty complicated. Wouldn’t it be nice if we could, instead, speak in plain language to automatically initiate any change in the backend? For some scenarios, a natural language facade may just be where web APIs are heading. Read more

8+ OpenAPI Linters

OpenAPI is now a widely-adopted method for describing web APIs. With that fact comes the pressure to validate these specifications are up to date, accurately constructed, and presented for optimal developer usage.

Especially with the shift from OpenAPI v2 to v3, developers may require further assistance to ensure their specification matches the current v3 structure and format. Read more

7 Protocols Good For Documenting With AsyncAPI

Documentation is arguably the most important part of any API strategy, as it’s often the direct route between developer and user, and a direct conduit through which the developer can inform, educate, and contextualize. Accordingly, finding good options for documenting your API is of prime importance. Read more

Tools to Make HATEOAS Compliance Easier

HATEOAS is, in essence, a value proposition and definition for what an API should do. HATEOAS, or Hypermedia as the Engine of Application State, is a specific constraint upon the REST architecture. For many, however, HATEOAS seems a nit-picky addition to the slew of API design best practices. Read more

7 Items No API Documentation Can Live Without

Web APIs are highly variable things – they can be custom-built, designed around a single purpose, all-encompassing, and almost everything in between. Shifting requirements dictate what the interface is comprised of. Due to this, it’s hard to find commonalities between APIs and their user-facing portals. Read more