rawnly/windocs

Tailwind powered api docs generator.

Windocs

A nice looking swagger alternative. Powered by Tailwind

Usage

• Clone the repo,
• Create a .env file with SWAGGER_URL pointing to a valid OpenAPI json (must be an HTTP url).
• build it (npm run build) and start the server (npm start)

Caveats / TODO

• Missing ENUM support
• Missing additionalProperties support.
• UI/UX can be improved a lot
• Auto open menu sections while scrolling (see ReDoc)
• Sometimes the body isn't correctly formatted.
• Add some info about the response type and consumation.
• Add Auth support
• Add "Try It" button.
• Code samples
• Dynamically generate basic HTTP code samples.

windocs's Issues

State of the project?

I've seen a tweet in june and wanted to check the state of the project. Is there anything that can be helped with? Is this still being developed on or will keep the PoC state?

I am not the best with react but could try to help.