redoc VS slate

Link: Redoc

OpenAPI is great, we use it in combination with redoc (https://github.com/Redocly/redoc) to have a almost 0 effort API for our product.

But man, my tokenizer is in trouble with OpenAPI and OpenAI.

Redoc: Generate API documentation

ReDoc Interactive Demo

ReDoc focuses on simplicity and readability, presenting the API documentation in a user-friendly format. It supports dark mode, multiple languages, and offers a seamless browsing experience for API consumers.

There are a few other tools out there that are at least marginally better than the default Swagger UI such as ReDoc (https://github.com/Redocly/redoc).

When we redid the Mux docs (https://docs.mux.com/api-reference) we actually just decided to build our own renderer. It really wasn't as bad as you might think, at build time we pull in the JSON version of our OAS spec and render it as a static build in our Nextjs app. Don't get me wrong, it wasn't trivial, but the benefit of having complete control over the output has been well worth it.

Redoc: http://localhost:8080/redoc

ReDoc is a tool that's similar to Swagger UI. It also takes an OAS and renders an interactive HTML page with full API documentation details; however, it has a notable difference.

take a look

Slate (Free)

https://github.com/slatedocs/slate this ! Big company use it ( stripe etc )

The second most common question being "What framework does Stripe use to build their documentation?" and the answer has unfortunately always been "They use a custom setup they built themselves and isn't available." － so then Slate gets brought up as a suitable replacement

DocuAPI is a multilingual API documentation theme for Hugo created and maintained by Bjørn Erik Pedersen, the lead maintainer and co-creator of Hugo itself. It’s built on top of the Slate API docs generator, which itself was inspired by Stripe’s and PayPal’s API docs. The JavaScript section of DocuAPI has been rewritten from Jquery to AlpineJS.​​​​​​

I've used Slate to document APIs which similarly will produce a local website. You can host that privately or there's built in support to push to github pages if you're hosting it in a github repo. The documentation itself is all written in markdown and managed separate from your API code.

Clone/inspired by stripe docs: https://github.com/slatedocs/slate

If you are going to use Slate from the console you need to install it, along with all its prerequisites, as described here. In Ubuntu you can execute the commands:

Slate - API Generator