Hacktoberfest2023 VS redoc

Official Hacktoberfest Website GitHub's Blog DigitalOcean's Blog

You're probably a little late for Hackoberfest this year.

A few days ago, I made my Final Pull Request for this year's Hacktoberfest event, and it seems to be a perfect timing for publishing a recap of the entire experience.

One of the most exciting celebrations of open source is Hacktoberfest, an annual event held throughout October that brings together developers from around the globe to contribute to open-source projects.

Hacktoberfest is happening and I see a lot of really cool movements, like articles here on Dev and in the community on Discord! (And that's really cooooll)

I’m proud of the ctfd-account-hook project and I welcome contributions to it! I’m participating in Hacktoberfest, so you can get badges for getting pull requests accepted.

Hacktoberfest is an annual event that encourages open-source contributions on platforms like GitHub by submitting four pull requests. It's a valuable opportunity for collaborative coding and gaining experience.

Finding machine learning projects that are suitable for JS/TS developers during Hacktoberfest can be daunting due to the overwhelming abundance of open-source projects. We’ve simplified this process, offering you a refined selection of opportunities where your coding skills can shine and make a real impact.

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.