3
16 Comments

Best hosted api documentation tool?

I'm looking for a tool like gitbook.com to publish API docs. It has to be free or super cheap (<5$/mo) and support custom domain (docs.mysite.com).
Any tips?
I've tried Gitbook but found the editing is pretty clunky (e.g. can't reorder params in an API description, copy/pasting h

  1. 2

    We use https://swagger.io/ Swagger. It is very powerful but hard to get started on it

    1. 1

      Can you show me a sample documentation built with swagger?

  2. 1

    Hi guys, I'm very new to API documentation and have been browsing for a few free/freemium ones. For the record I'm a product manager and might not understand all the features mentioned on tools like redocly, postman, gitbook, etc.

    The requirement for our API documents are as follows:

    1. They are private, and are only shared with clients post an agreement.
    2. Each client get's a login/password to access our custom API docs at the moment.
    3. Each client get's grants to access only the APIs that have been agreed upon, out of the 150+ APIs we have.

    Any suggestion on which tool works the best for this? Thanks.

  3. 1

    I'm building something that might help. https://mylodocs.com. It creates a documentation site from markdown files stored in Github. No editing capabilities yet, but there are plenty of good markdown editors.

    1. 1

      This looks perfect for my new project, signing up now, thanks!

  4. 1

    Not specific to API docs, but GitBook is pretty slick for publishing docs kept in version control.

    1. 1

      Design looks great but it's pretty clunky when editing tbh.

  5. 1

    I'm looking to try out https://github.com/lord/slate

    It does require a server though. But you can easily set it up for free with a cheap machine on Google Cloud.

    I'd be interested to hear other options as well

    1. 3

      We run on Slate and host it on Github: https://api.supervisor.reviewshake.com/#introduction. Very simple deploys.

      1. 1

        Looks like exactly what i need. Can you tell me how your deployment process is like?

    2. 2

      Doesn't need to be on a server, it builds a static site. Used it for a previous project. Host on Netlify for free easy hosting as well.

      1. 1

        Thank you for clarifying !

    1. 1

      Thanks, but doesn't look like it's suited for API docs. It looks more like a more generic solution for general documents sharing.

  6. 1

    This comment was deleted 2 years ago.

Trending on Indie Hackers
How I grew a side project to 100k Unique Visitors in 7 days with 0 audience 47 comments Competing with Product Hunt: a month later 33 comments Why do you hate marketing? 27 comments $15k revenues in <4 months as a solopreneur 14 comments Use Your Product 13 comments How I Launched FrontendEase 13 comments