slate VS redoc

Slate (Free)

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

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.​​​​​​

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

I'm using Slate right now which is a common recommendation for Stripe-like documentation, but obviously it's not the same.

While not as visually impressive with flashy graphics and UI elements, Twilio's documentation has similar Stripe vibes as I believe it's built on Slate which is about as close to Stripe's framework as you can get. I like the theme used[4] in the code sample section as it's a nice break from the standard colors and it's easy on the eyes.

That's about the API design and specification. Now let's turn our attention to API UIs for visualisation and interaction. API UIs are useful for other people to easily understand your API. Again, quite a variety of choices in this area, but the most common are Swagger UI and Redoc. Lots of frameworks and tools will allow you to render the Swagger or Redoc UI of an OpenAPI spec from the specification document, such as Swagger's editor. And if you're comfortable enough with JavaScript, you can do the rendering yourself using the npm package. A fancier UI is Slate. I don't know whether Slate will automatically generate code samples in every popular language, but it does allow you to write the samples yourself. There're various tools that render a Slate UI from an OpenAPI specification. I believe Postman also allows you to generate a fancy UI.

For API-specific docs I use Slate as I like the code sample section off to the right. I converted our previous severely lacking Swagger setup to a full-featured framework with Slate that has significantly reduced the number of support emails regarding API questions.

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.

If you want to see how Redoc will render your OpenAPI definition you can try it out online at https://redocly.github.io/redoc/.

Redoc is an open source tool to generate API reference documentation websites from OpenAPI definitions.

FastAPI for Python has an awesome way of doing this. It comes with two choices: Swagger and Redoc, the former being more interactive while the latter is (IMO) more visually appealing. I'm sure you could implement one of these using Spring.

Starlite has substantially enhanced OpenAPI (3.1) documentation - in fact, its the most complete autogenerated schema around, and it ships with Redoc, Swagger-UI and Stoplight-Elements static sites.