Awesome
OAX — OpenAPI Specification Explorer
Resources
- Online demo
- Automated screenshots
- Research notes
Status
Feature | Status | Note |
---|---|---|
OpenApi directory browser | 100% | 500+ API specifications powered by APIs.guru |
SDK code generator | 100% | powered by swagger-codegen via generator.swagger.io |
Markdown & syntax highlight | 100% | using showdown & highlight.js with 40 language highlighters |
Using web worker | 100% | for non-blocked user interface |
Light & dark theme | 100% | thanks to Vuetify |
Built-in HTTP reference | 100% | by know-your-http-well |
Responsive & mobile | 100% | |
Offline & progressive | 80% | |
Keyboard shortcuts & navigation | 80% | |
View & layout options | 80% | |
Schema & examples | 75% | |
Try out API | 50% | |
CORS proxy | 50% | |
Edit specification | 50% | using CodeMirror editor and web worker<br><br>TODO:<br>hinting<br>scroll to operation<br>markdown<br>YAML |
Search | 10% | |
Security definitions | 25% | |
Customization & configuration | 10% | |
SEO & SSR | 0% | |
Local storage for user settings | 0% | |
Cross-browser compatibility | 0% | not tested yet (Chrome browser should work) |
Print style & PDF export | 0% | |
OpenAPI version 3.0 | 0% |
Build Setup
Install
npm install # or yarn (yarn required for NUXT build)
Webpack
npm run webpack:dev # serve with hot reload at localhost:8080
npm run webpack:build # build for production with minification
npm run webpack:report # build for production and view the bundle analyzer report
For detailed explanation on how things work, checkout the guide and docs for vue-loader.