Factsheet
What are your favorite examples of good API documentation?
I personally like the MSDN documentation style. Full outline of all the methods, explanations of what they do, links to objects you pass in, list of expected exceptions to be thrown.
More on reddit.comWhat's the deal with companies and not documenting APIs anyway?
How do you enforce that your API actually fulfills your Open API documentation?
Your FastAPI Swagger UI is exposed? here's my super simple solution to lock it down in 30 seconds.
Videos
I'm working on a project synthesizing the best properties of good API documentation. Part of this involves learning what "good" means to everyone. Unlike prose or fiction, API documentation can absolutely be standardized and made more effective.
So please share any examples of what you consider are good API documentation, and why.
I personally like the MSDN documentation style. Full outline of all the methods, explanations of what they do, links to objects you pass in, list of expected exceptions to be thrown.
Swagger documentation is fantastic. In-line "try it now" boxes, example input and output json/xml, full model specification... mmm, love me some swagger documentation.