Web API Documentation & OpenAPI
A companion page of resources for a presentation on documenting APIs
Questions? Feel free to email the author of this presentation & resources list.
Links to further resources
Expand all
Some real-world API documentation sites
Spotify
SkyScanner
GitHub
Amadeus (GDS)
Stripe
Shopify
SendGrid
Google Cloud Storage
Learn API & developer documentation
Online resources
I'd Rather Be Writing Documenting APIs course
FreeCodeCamp API Documentation Best Practices video course
Books
Docs For Developers
Docs Like Code
Docs As Ecosystem
OpenAPI
* Also see the Publishing developer documentation resources list for publishing & webpage generation tools that support OpenAPI.
Publishing developer documentation
Documentation hub/portal platforms with hosting and support for API reference generation
Mintlify
Stoplight
Redocly
Docusaurus
ReadMe
GitBook
Writerside
Antora
Fern
SwaggerHub Portal
Documentation generation, hosting not included
Sphinx
MkDocs
API reference generation from OpenAPI, hosting not included
SwaggerUI
Redoc
Stoplight Elements
Rapidoc
API testing tools
cURL tutorial (GUI tool)
Postman (CLI tool)
Markup languages
Markdown Guide
ReStructuredText
AsciiDoc
Data serialization languages
YAML
JSON
Miscellaneous
Postman State of the API Report 2023
PublicAPIs.dev - a collection of public APIs
RapidAPI Hub - private and public APIs
Introduction to git and GitHub (W3Schools)
Learn Git Branching