API Documentation

A collection of 4 posts
6 Most Significant Changes in OAS 3.0

6 Most Significant Changes in OAS 3.0

The OpenAPI Spec, formerly known as Swagger has announced the release of Open API Specification 3.0. This is a very important milestone, but it is also the first major release since the specification was entered into the Linux Foundation. The OpenAPI Specification (OAS) is supported by various industry heavyweights »
Documentation Driven API Design

Documentation Driven API Design

API Documentation Documentation doesn’t have to be as herculean a task as it is made to appear. This assumption has made documentation to be seen as something to be done as an afterthought, which is usually a nightmare for any developer who has been assigned the difficult task of »
Restful API Documentation SUCCESS Strategy

Restful API Documentation SUCCESS Strategy

When defining an overall API documentation strategy, it means that this strategy should unify your API design and documentation, causing them to work together to produce a better developer experience. The most important thing to remember that most of the users / readers of your restful API are developers or at »

API Documentation "Almost" Done Right

I’ve integrated with, and also built, not a small number of APIs in my years, working on different web services, defining restful API's and more... Over the course of integrating with and researching a bunch of APIs, I’ve looked at the documentation of the APIs I »