Need help with oax?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

darosh
229 Stars 39 Forks MIT License 1.1K Commits 37 Opened issues

Description

OpenApi Specification Explorer

Services available

!
?

Need anything else?

Contributors list

OAX — OpenAPI Specification Explorer demo: online

Resources

Status

Feature

Status Note
OpenApi directory browser 100% 100% 500+ API specifications powered by APIs.guru
SDK code generator 100% 100% powered by swagger-codegen via generator.swagger.io
Markdown & syntax highlight 100% 100% using showdown & highlight.js with 40 language highlighters
Using web worker 100% 100% for non-blocked user interface
Light & dark theme 100% 100% thanks to Vuetify
Built-in HTTP reference 100% 100% by know-your-http-well
Responsive & mobile 100% 100%
Offline & progressive 80% 80%
Keyboard shortcuts & navigation 80% 80%
View & layout options 80% 80%
Schema & examples 75% 75%
Try out API 50% 50%
CORS proxy 50% 50%
Edit specification 50% 50% using CodeMirror editor and web worker

TODO:
hinting
scroll to operation
markdown
YAML
Search 10% 10%
Security definitions 25% 25%
Customization & configuration 10% 10%
SEO & SSR 0% 0%
Local storage for user settings 0% 0%
Cross-browser compatibility 0% 0% not tested yet (Chrome browser should work)
Print style & PDF export 0% 0%
OpenAPI version 3.0 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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.