Giter Club home page Giter Club logo

oas-ui's Introduction

OAS UI

OpenAPI 3 Specification User Interface (interpreter).

OAS UI allows to visualize API resources based on the given OpenAPI specification v3.

Main features

  • supports OAS v3
  • allows to search components and resources
  • correctly displays inheritance and attributes ownership
  • supports inheritance discriminator definition
  • supports complex examples (JSON format in expandable JSON tree view)
  • supports property/parameter validation description
  • allows to display component detail in resource view
  • usable in any language using bundled js
  • responsive and user-friendly design

CDN for bundled js

https://unpkg.com/oas-ui@latest/dist/bundle.js

Current version

1.1.0

Live demo

https://vahanito.github.io/oas-ui-example/

Usage

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no"/>

    <title>OAS UI 3 Usage demo</title>
	
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"/>
    <script src="https://unpkg.com/oas-ui@latest/dist/bundle.js" type="text/javascript"></script>

    <script type="text/javascript">
		function initialize() {
			showOas.showOas('/spec/url', null , "content");
		}
    </script>
</head>

<body onload="initialize()">
<div id="content"/>
</body>
</html>

oas-ui's People

Contributors

vahanito avatar jrcodeza avatar juffalow avatar

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.