redoc VS openapi-generator-cli

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

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.

Hi, I want to create my dto's from a bundle file. This works nearly good, I just don't need all the functions which I am getting. I only need the model structs. I am currently using https://github.com/OpenAPITools/openapi-generator-cli via docker and I am passing the bundle.yml inside. I have the following parameter to only get model files:

You can generate boilerplate code stubs with OpenAPI spec. Yes! you heard it right! you only need to write the business logic that’s all, everything will be generated for you. There are so many generators available for every programming language. Find it here https://openapi-generator.tech. GitHub repo for the same https://github.com/OpenAPITools/openapi-generator & https://github.com/OpenAPITools/openapi-generator-cli

- https://github.com/OpenAPITools/openapi-generator-cli

OAG is a Java project that uses Mustache templates to configure each supported programming language. It provides a CLI openapi-generator-cli that will download the appropriate JAR file and invoke the java executable to run OAG.

So I'm assuming you're talking about generating Rust types from TypeScript? If you can get your typescript definitions into OpenAPI (i.e, via typeconv) you can use the openapi generator cli to generate rust types. However this is geared towards web backends rather than pure IPC or cross-lang interop.

https://github.com/OpenAPITools/openapi-generator-cli I didn't build it so you may need to do some research on it

openapi-generator-cli is what I use for openapi/swagger, along with the nestjs swagger plugin. it's not perfect but it gets the job done.

The OpenAPI generator configuration file. See Configuration for more info.