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.
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 matc...
Do you have a favorite survey or poll tool to get feedback, or a unique process to get actionable insights from your users about your design, product features, pricing, and more? There was an inte...
I've been using Confluence since 2013, and in my opinion, it's the best document collaboration tool. Lately, I've seen that Notion is getting trendy. Any Notion heavy user around?