Design and Build Great Web APIs

Generating Your API Documentation

No matter how well you design your API, both server developers and API client developers will need some level of documentation in order to understand and use your API. And the OpenAPI Specification has some really nice support for generating simple documentation.

The API documentation is very much along the lines of “technical” docs: it only includes the set of endpoints and the associated parameters, request bodies, response bodies, and schemas you included in your document. There is no extended prose covering why someone might want to use your API—nothing like a how-to guide or common problems list or anything like that. But basic technical docs are a good start.

SwaggerHub’s Generated Documentation

You can ...