https://github.com/bodinsamuel/openapi-doc-generator
Beautiful documentation generator based on your Swagger, Open Api spec
https://github.com/bodinsamuel/openapi-doc-generator
api documentation documentation-tool swagger
Last synced: 2 months ago
JSON representation
Beautiful documentation generator based on your Swagger, Open Api spec
- Host: GitHub
- URL: https://github.com/bodinsamuel/openapi-doc-generator
- Owner: bodinsamuel
- License: mit
- Created: 2018-03-29T13:26:42.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-11T15:28:34.000Z (about 8 years ago)
- Last Synced: 2025-07-30T15:31:03.761Z (11 months ago)
- Topics: api, documentation, documentation-tool, swagger
- Language: JavaScript
- Homepage: https://bodinsamuel.github.io/openapi-doc-generator/
- Size: 5.45 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Open API Doc Generator
A very simple way to generate a beautiful and usable documentation with your open api specifications. It use [vue.js](https://github.com/vuejs/vue).
# Usage
## Installation
```javascript
this is a very WIP project,
there is no npm or standalone for now
```
## Documentation
You can check our [live example](https://bodinsamuel.github.io/openapi-doc-generator/) and read the [documentation](/Documentation.md)
# Todo
- [ ] Metadata (title, description, logo...)
- [ ] Schema Request display
- [ ] Schema Response display
- [ ] Error Schema Response display
- [ ] Custom markdown
- [ ] web Console for testing
- [ ] Server Side Rendering
- [ ] Library build + versionning
- [ ] 404 on bad url
- [ ] redirect/404 on bad slug
- [ ] input quick switch for demo purpose
- [ ] Sidebar responsivness
- [ ] Search
- [ ] Analytics wrapper
# Contributing
Please, this project is open to any contribution or request, I'll be glad to review and merge them. This project use prettier, eslint and husky to handle coding style automatically.