What's the best tool to write and host API documentation?
I am planning to open up APIs for Blanq but, at this point I am not sure where to write and host the documentation for it.
Do you use anything for your application or know some tool or framework that I can use?
Trending on Indie Hackers
I would suggest writing the docs in OpenAPI Specification.
Depending on how you have created your API you might be able to automatically generate docs in the OpenAPI v3 spec as many different frameworks across many different languages.
A while back I needed to write an API doc for an API that didn't exist yet and I found Apicurio studio the nicest UI based editor to use before I got used to the OpenAPI syntax. I found it much easier to use ReDoc, Swagger etc.
As for hosting, I would suggest bundling the API docs along side you API, host on the same server inside the same code base to ensure everything is deployed together and your docs can't be forgotten. There are quite a few tools to create static HTML files from a OpenAPIv3 spec.
I used ReDoc to deploy using a static HTML and JSON file next to each other and it worked great.
Hope that helps.
Awesome. Thanks, this makes a lot of sense.