Giter Club home page Giter Club logo

oax's Introduction

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.

oax's People

Contributors

darosh avatar

Watchers

James Cloos avatar Dave Tonge avatar Maciej Dw avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.