Ask HN: How do you write API documentation?

3 points by b01t ↗ HN

2 comments

[ 2.8 ms ] story [ 12.0 ms ] thread
In a text editor. Why?
For Web APIs OpenAPI Specification has been a great resource for internal and external projects. With viewers like https://github.com/Rebilly/ReDoc/ it gets pretty easy to take the spec and generate something pleasing for a consuming developer.

Unless you are talking about native code APIs ...