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 postman is actually extremely underrated for this. Their API doc generation is really good and has the obvious benefit of easy end-user testing since your customers can just download the collection. And it is easy to keep up to date because you likely use it yourself to test new endpoints or updates to old endpoints.
Interesting, I've used Postman to test API calls, but never to build documentation. Didn't realize they had a tool for that! The "Run in Postman" button could be huge for building interactive API documentation.
Does it maintain documentation for older versions of your API as well?
It basically just keeps your saved postman collection updated with your public documented collection. I haven't used it much other than showing people how our API works.
You can check it out here: www.postman.com/use-cases/developer-portals
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.
Ohh that looks super nice, thanks for sharing! Was it reasonably easy to get code samples lined up with the relevant documentation?
Looking for a better way to plan remote meetings across time zones, and keep up with events. What software is doing that best today?
We have 15k newsletter subscribers, and have around ~2k of them in a Slack group. We're starting to encounter issues in terms of community management - specifically, it's hard to pin content like c...
Google lets you subscribe to a calendar using a URL - although when using an Outlook 365 Calendar link, events are copied over once, and then the syncing stops. This seems to be a relatively new is...
"It's not about obtaining, it's about maintaining." That's so true for all documentation—it gets outdated so quickly!
Hi @forouzani! Thanks a lot for sharing these tools. I will look into it. They seem to suit my needs 🙏