I'm on the hunt for a platform that can help me create beautiful API documentation, similar to how Stripe does it. I remember seeing a website that claimed they would help with this, but I can't seem to find it anymore. Any recommendations on where to host API docs so they look really polished?
4 Answers
While I haven't used it myself, I've heard good things about swagger.io. Our contractors built an API using it, and it’s pretty solid for documentation.
Gitbook is another option to consider! It can be used to create visually appealing documentation for your API.
You might want to leverage the OpenAPI specification. It allows you to document APIs with YAML. After that, you just need to find a hosting service that can work with OpenAPI-compatible documents.
You should check out markdoc.dev! It's a great option for making your API docs look amazing.
I'm definitely saving this for later, thanks for the tip!
I've documented around 100 endpoints with swagger. It uses YAML to describe endpoints, which is great for larger APIs, though I found it lacked a code-to-docs feature last I checked.