Skip to content
Browse and test a REST API described with the OpenAPI 3.0 Specification
Branch: master
Clone or download
Latest commit 84fd8db Dec 17, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
public fix: use taggedElement strategy for iframe resizer Oct 24, 2018
server
.babelrc
.eslintrc.js chore: missing files at root Mar 14, 2017
.gitignore chore: missing files at root Mar 14, 2017
Dockerfile chore: fix docker image build Jun 26, 2018
LICENSE updated license Dec 2, 2017
README.md
bs-config.js
nodemon.json
package-lock.json 1.4.2 Dec 16, 2018
package.json
webpack.config.js

README.md

OpenAPI 3 viewer

This service is designed to easily browse and test a REST API described with the OpenAPI 3.0 Specification (fka Swagger Specification). This service mainly uses vue-openapi component. It also provides a simple nodeJS backend for proxy purpose.

See it in action :

Install

Clone this project and install dependencies with npm install or yarn then :

npm run dev

Launch the service with Docker

A Docker image is publicly available on dockerhub.

Run the following command :

docker run -p 8080:8080 koumoul/openapi-viewer

and go to this page

Query parameters

You can use the followings query parameters to prefill viewer

  • url : The location of the API documentation file to load, in OpenAPI v3 JSON format.
  • proxy : true or false if you want to fetch API documentation file using this service backend as a proxy. Defaults to false. Can be usefull if the API description can't be reached with CORS headers. Do not use the proxy if you want to access an API description located on localhost.
  • headers : URI encoded JSON dictionnary of headers that will be used to prefill parameters if they match. Can be usefull to prefill x-api-key or authorization headers.
  • query-params : URI encoded JSON dictionnary of query parameters that will be used to prefill parameters if they match. Can be usefull to prefill an organizationId parameter in a multi-tenant application.
  • hide-toolbar : true or false of you want to hide toolbar. This can be usefull for iframe integration. Defaults to false.
You can’t perform that action at this time.