https://github.com/rawnly/windocs
Tailwind powered api docs generator.
https://github.com/rawnly/windocs
Last synced: 7 months ago
JSON representation
Tailwind powered api docs generator.
- Host: GitHub
- URL: https://github.com/rawnly/windocs
- Owner: rawnly
- Created: 2021-06-15T17:13:51.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-06-17T01:18:21.000Z (almost 5 years ago)
- Last Synced: 2024-12-28T09:43:23.564Z (over 1 year ago)
- Language: TypeScript
- Size: 41 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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.