Skip to content

[DEPRECATED] A visualiser for Open API definitions such as Swagger.

License

Notifications You must be signed in to change notification settings

temando/open-api-ui

Repository files navigation

This project is now deprecated. We're working on a cleaner renderer that supports Open API v3. See Open API Renderer

Temando Open API UI.

Travis CI MIT License Greenkeeper Github Forks Github Issues

This project is a Material Design themed Open API UI built using React. It visualises Open API (Swagger) definitions such as Swagger.

It was inspired by the Material Swagger UI project.

Install

$ git clone [email protected]:temando/open-api-ui.git
$ cd temando-open-api-ui
$ npm install

Usage

The following will start a webpack development server at http://localhost:8100/.

$ npm run start

When running locally, app requires a url parameter that points to a valid Swagger file.

For example:

Note that the response headers for a request to the swagger file must have CORS turned on. Otherwise the browser will throw a CORS error.

Deploy to production

Run the following to generate the artifacts at /dist:

npm run build:dist

Deploy the files at /dist to your server.

About

[DEPRECATED] A visualiser for Open API definitions such as Swagger.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published