darosh / oax Goto Github PK

View Code? Open in Web Editor NEW

261.0 261.0 44.0 37.86 MB

OpenApi Specification Explorer

Home Page: https://darosh.github.io/oax/

License: MIT License

JavaScript 40.78% HTML 0.98% Vue 42.07% TypeScript 11.44% CSS 4.72%

oax's People

Contributors

Stargazers

Watchers

Forkers

paul-javs asifarran yongaru athiwatp mockingloris digiglu rasata rmannibucau pingf alvawymer mmolieleng guillemcanal smile921 tommylike paulwang001 moneyhub yydmss seb-openbanking openbankingse hovik-aghajanyan darmawan01 hellion23 streamr-dev paperscz nikiai crazysunshine yyy-team primespace tokenyz-ventures-limited phamtuanit xiaohengdd romanbronevik freshusername hexf kirschd zwq000 sncap strongerlph codehand fairhopeweb rengerden julia-qian foottu jccabral

oax's Issues

Authorization header on OAS3 specification not present.

We have noticed that when loading a Swagger 2.0 specification, the authorization header (lock) button on top of the page is present and seems to work normally. However when loading a OAS 3.0 specification that is not present. Is that something that is known to be missing? If so, any plans to add it soon?

We understand that security definitions are only at 25%, so it seems reasonable for it to not be working. That said, great job so far! It looks really good.

Download dialog: blob in iframe not displayed in Edge

Graph missing horizontal scrolling on mobile

Add categories to meta info list

It may seem redundant but we want to provide user high level overview of API at first sight.

In directory listing we show only first category icon.

Right panel: operation header transition blink in Firefox

Add Authorization Documentation

Currently I'm on a fresh install of oax. Adding a API token key (using the nav bar button and modal) does not seem to be consumed by any of the following API REST calls I test. I'm not sure if it's meant to be in a working state because there isn't any documentation about this feature.

My request is, if the token authentication is meant to be in a working state, could you include some documentation, examples or general advice on how to get the Swagger API end point testing to use the provided token.

Thanks!

Q: is it possible to define some global variables?

I use swagger ui before.
I found oax today, it's awsome!!

I always want to define some global variable,
so I can use them at anyway in openapi.yml.

like the variable used in bash or javascript string:

var1='abc123'
str1=`hello ${var1}`

original openapi spec seem not support this,
extensions or some hack can do it easily?

Loading Local specifications

Is there a way to point this at a local server endpoint or static file instead of it loading APIs.guru?
I wasn't able to find how to do this.

Missing page <title>

What is webpack/nuxt compatible way?

Error: Duplicate export 'alg' node_modules/ciena-graphlib/index.js

plugins/graphlib.esm.js → plugins/graphlib.js...
[!] Error: Duplicate export 'alg'
node_modules/ciena-graphlib/index.js (null:null)
1: /**
2:  * Copyright (c) 2014, Chris Pettitt

npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] vendor:graphlib: `rollup --config rollup.graphlib.config.js plugins/graphlib.esm.js --output.format es --output.file plugins/graphlib.js`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the [email protected] vendor:graphlib script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /home/user/.npm/_logs/2018-02-24T15_57_55_149Z-debug.log
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] postinstall: `npm run vendor:vuetify && npm run vendor:d3 && npm run vendor:walk-parse5 && npm run vendor:lodash && npm run vendor:graphlib && npm run vendor:dagre && npm run vendor:icons-bundle`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the [email protected] postinstall script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /home/user/.npm/_logs/2018-02-24T15_57_55_329Z-debug.log

Expander headers in right panel had grey background

Probably caused by some Vuetify theme style fix or upgrade.

Missing selected/hover/ripple operation highlight

tables
graphs

release a beta

Hi,

congrats for your wonderful work!

is it possible to have a beta release before it is dev-complete?

Thanks a lot and keep up the good work!
Romain

Missing background in dark theme on mobile scroll

Finish shema views

...and schema list ...should we use expanders, or keep dialogs?

Doesn't show request body params, and doesn't add a request body in the code examples.

Some of my routes have a required JSON request body. oax doesn't show which parameters are needed in the request body, rather it only shows the comment from the request body, which isn't enough information to make a successful request.

The code examples also don't show sending a request body at all, which they should show, otherwise they are showing an incorrect and incomplete request example.

And is there a way to show the code examples using the standard fetch() instead of axios and angular, which I think should be deprecated now that we have fetch?

Document supported vendor extensions in spec

Some <a> links have ".primary" and some ".theme--light/dark a" color

Missing full screen edit on mobile landscape

Add scheme relation graph view

Static HTML?

Hi -

I would like to try this, but my requirements limit to using static HTML for swagger-ui's. So, the question is, can this run without server-side code/files, where the URL to swagger-json would be fed to client-side code in some standard way, e.g. query or via some customizable script in home-page (much like your first project: https://github.com/darosh/angular-swagger-ui-material)?

I did run npm-install, hoping that such files would be generated, as I didn't spot them in the source either.

Thanks.
Hari