Home

Awesome

OAX — OpenAPI Specification Explorer demo: online

Resources

Status

FeatureStatusNote
OpenApi directory browser100% 100%500+ API specifications powered by APIs.guru
SDK code generator100% 100%powered by swagger-codegen via generator.swagger.io
Markdown & syntax highlight100% 100%using showdown & highlight.js with 40 language highlighters
Using web worker100% 100%for non-blocked user interface
Light & dark theme100% 100%thanks to Vuetify
Built-in HTTP reference100% 100%by know-your-http-well
Responsive & mobile100% 100%
Offline & progressive80% 80%
Keyboard shortcuts & navigation80% 80%
View & layout options80% 80%
Schema & examples75% 75%
Try out API50% 50%
CORS proxy50% 50%
Edit specification50% 50%using CodeMirror editor and web worker<br><br>TODO:<br>hinting<br>scroll to operation<br>markdown<br>YAML
Search10% 10%
Security definitions25% 25%
Customization & configuration10% 10%
SEO & SSR0% 0%
Local storage for user settings0% 0%
Cross-browser compatibility0% 0%not tested yet (Chrome browser should work)
Print style & PDF export0% 0%
OpenAPI version 3.00% 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.