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.

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 git@github.com: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:

• To visualise PetStore v2 Swagger, go to http://localhost:8100/?url=http://petstore.swagger.io/v2/swagger.json

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.