7
18 Comments

Can you suggest me a tool to create API documentation?

I like how Airtable's API documentation works and I would like to create something similar to my project.

Can you suggest me any free or paid tool?

Thanks.

posted to Icon for group Developers
Developers
on July 9, 2021
  1. 9

    Hey, I recommend using OpenAPI specification to describe the operations of the API. Once you have the file, there are many tools to generate web pages or different things. I use them to generate frontend code (elm, typescript), backend code (java, Haskell), as well as using redoc for the API documentation page.

    https://swagger.io/specification/
    https://openapi-generator.tech/
    https://github.com/Redocly/redoc

    1. 1

      I second this - OpenAPI spec + redoc was the best option I found.

      redoc

    2. 1

      Thanks for the answer. I take a look on OpenAPI.

  2. 5

    I can recommand Bump: https://bump.sh/

    It uses standard files specifications and build for you a nice documentation + a changelog! I really like this feature that is missing from most API docs.

    1. 2

      Thanks. this is a really cool app and indeed the generated documentation looks nice.

      1. 1

        Hey Andras, feel free to ping me if you want, I'd love to hear more about your project and see how Bump can help your documentation 😊.

    2. 1

      Thanks Loïc for highlighting Bump 🤗, happy to chat anytime!

      1. 2

        You're welcome ;) I know Bump since its early beginning in France and I recommand it anytime someone asks for an API documentation tool :)

        1. 1

          That's awesome, it means a lot for us 💙

  3. 3

    (This is all free, you don't need any paid tools to do this out of the box)

    You want to start be generating the OpenAPI Specification. You don't need to generate this by hand (although it can be good to), most languages have a package that will generate one by annotating your services existing endpoints.

    The spec is here: OpenAPI Specification

    Once you have the spec available and can be served from an endpoint in your service, you can use any one of the existing UI packages to display the spec in a human readable format.

    For instance using the npm package openapi-explorer will generate a fully functioning UI with all the endpoints and methods:

    OpenAPI-Explorer

    1. 1

      Thanks, it looks great and similar to what i'm looking for. I'll try it.

  4. 2

    I've used these two for some projects as well as my own tool for https://docs.wobaka.com

    Recommend both!

    1. 1

      Thanks for the suggestion.

Trending on Indie Hackers
AI runs 70% of my distribution. The exact stack. User Avatar 181 comments I'm a solo founder. It took me 9 months and at least 3 stack rewrites to ship my SaaS. User Avatar 144 comments I used $30,983 of AI tokens last month in Claude code on $200/mo plan User Avatar 47 comments We could see our AI bill, but not explain it — so I built AiKey User Avatar 25 comments AI coding should not turn software development into a black box User Avatar 24 comments my reddit post got 600K+ views. here's exactly what i did User Avatar 21 comments