Posts Tagged: documentation

Review of Optic

We review Optic, a tool for auto-documenting and testing APIs

There are few things as important to the API developer experience as API specifications and API documentation. Both provide a vital conduit between the API provider and developer user, expressing critical information on functional aspects of the API. Read more

Do API Standards Differ From Industry to Industry?

At first glance, it would seem that the API space has embraced unified design standards. RESTful development uses HTTP to communicate between a client and a server. OpenAPI Spec serves to extend REST APIs, improving documentation and making APIs machine-friendly.

However, with just a little digging, it becomes apparent that this isn’t always the case. Read more

GraphQL Documentation Generators, Explorers, and Tools

Automatically generating documentation is a dream come true for developers looking to focus on the code instead of copywriting. It’s also a dream for end users, who get documentation that’s up-to-date and reliable.

GraphQL is a popular query language that lets developers extract the information they need from APIs. Read more

DX Should Be a Priority, Reveals State of API Report 2019

As we make the shift towards treating APIs more like bonafide products, Developer Experience (DX) is only becoming a more prominent topic. Over the last few years, you’ve probably noticed a growing amount of literature, tooling, and discussion on the subject of DX. Read more