Beyond OpenAPI

In this article, the author discusses the different types of documentation and introduces a concise and readable way to write interactive tutorials and how-tos for HTTP APIs. The author explains the basics of the HTTP protocol, including HTTP requests and responses, including the request line, headers, and body, as well as the status line, headers, and body of the response. The author provides examples of how to use HTTP to document API usage, including examples of reading and modifying gists using the GitHub API. The article concludes with an implementation of the API examples using JavaScript.

https://antonz.org/interactive-api-tutorials/

To top