Let's say you have an API you want to document and you want to:
- Let your users test their calls to the API thanks to a "playground" like the one on the Figma API
- Be able to customize it to match your brand guidelines
- Be able to customize its content easily. If I want to have a glossary on a specific page for instance.
Thanks in advance 😉
I would recommend using Redoc.
It uses swagger so pretty standard, is very feature rich, and can be easily customized to suite your needs.
You can build simple playgrounds with the Swagger Editor or you can drop in a repl if you want something more advanced.
Just remember that when it comes to API documentation... it's not about obtaining, it's about maintaining.
I checked with @adamd, a friend who's a developer evangelist and technical writer, and here were his recommendations:
- Redoc (open source, redoc.ly is company version)
Some others, though less a focus for their company:
- Swagger UI
Several open source frameworks, too, but they usually don’t focus on the interactive piece.
I think Stoplight is really good and they keep improving the tool!
We are on readme and really love the product in terms of finesse and the theme they bring to docs. On the downside they are fairly expensive.
We started with publishing an API ref off postman initially, and in early days it was definitely the way to go for us.
Another one worth looking at is Slate, which we use at my startup - https://github.com/slatedocs/slate
It's on the simpler side of the complexity spectrum. It lets you write the docs in extended Markdown syntax and it gives you basic branding customization capabilities.
No playground support though.
I've used Airtable extensively to build simple internal apps as minimal viable products, but would love to build something bigger without coding. What are your favorite tools to build MVPs?
My Knowledge Processing Pipeline looks like this: Instapaper → Readwise → Roam Research. Recently I struggled with discovering quality content to pipe through the line. What’s your way to fill yo...
Sticky notes on a wall? Random ideas on a whiteboard? Outlining or mind-mapping apps? Kanban cards, notes connected in a Roam Research-style wiki, random ideas scribbled down on paper until somethi...