Coder Social home page Coder Social logo

temando / open-api-ui Goto Github PK

View Code? Open in Web Editor NEW
2.0 5.0 3.0 1.1 MB

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

Home Page: https://github.com/temando/open-api-renderer

License: MIT License

HTML 1.15% JavaScript 90.66% CSS 8.19%
swagger open-api

open-api-ui's Introduction

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.

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.