swagger-jsdoc VS redoc

For this task, we are going to use swagger-jscode. It says that it is to write Swagger, old name of OpenAPI, inside jsdoc, like below

js doc style comments support

There's swagger-ui-express which can work with swagger-jsdoc.

If so, how do you go about generating the interface files? I recently discovered swaggo which generates OpenAPI docs from Go annotations. My Googlefoo then led me to swagger-jsdoc and openapi-comment-parser which do the same thing from JSdoc-like comments. Do you use them, do you use some other module, or do you use some other approach entirely?

Express by itself lacks a lot of metadata useful for generating OpenAPI spec, you'll end up writing a lot of non-standard doc comments. You want to use something like swagger-jsdoc to generate the spec and then some other package to generate the UI.

This article is a continuation of a series about how to build a REST API in Node.js. In the preceding article of this series we added request and response validation that is based on an OpenAPI spec of the API. We used the swagger-jsdoc package to generate this OpenAPI spec from comments in our code that annotate the REST operations.

The swagger-jsdoc package enables us to do this. It looks for JSDoc comments in code (annotated with an @openapi tag) to generate the OpenAPI specification.

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.