redoc-ex

v1.14.5

Published

2 years ago

Swagger-generated API Reference Documentation

Downloads

0High
0Medium
0Low

kushwahashiv

OpenAPI OpenAPI Specification Swagger JSON-Schema API REST documentation Angular 2

ReDocEx

OpenAPI/Swagger-generated API Reference Documentation

Deployment

TL;DR

<!DOCTYPE html>
<html>
  <head>
    <title>ReDocEx</title>
    <!-- needed for adaptive design -->
    <meta charset="utf-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1">

    <!--
    ReDocEx doesn't change outer page styles
    -->
    <style>
      body {
        margin: 0;
        padding: 0;
      }
    </style>
  </head>
  <body>
    <redoc-ex spec-url='http://petstore.swagger.io/v2/swagger.json'></redoc-ex>
    <script src="node_modules/redoc-ex/dist/redoc-ex.min.js"> </script>
  </body>
</html>

That's all folks!

1. Install ReDocEx

Install using npm:

npm install redoc-ex --save

2. Reference redoc-ex script in HTML

For bower:

<script src="bower_components/redoc-ex/dist/redoc-ex.min.js"> </script>

For npm:

<script src="node_modules/redoc-ex/dist/redoc-ex.min.js"> </script>

3. Add `<redoc-ex>` element to your page

<redoc-ex spec-url="url/to/your/spec"></redoc-ex>

4. Enjoy :smile:

Configuration

Security Definition location

You can inject Security Definitions widget into any place of your specification description. Check out details here.

`<redoc-ex>` tag attributes

spec-url - relative or absolute url to your spec file;
scroll-y-offset - If set, specifies a vertical scroll-offset. This is often useful when there are fixed positioned elements at the top of the page, such as navbars, headers etc; scroll-y-offset can be specified in various ways:
- number: A fixed number of pixels to be used as offset;
- selector: selector of the element to be used for specifying the offset. The distance from the top of the page to the element's bottom will be used as offset;
- function: A getter function. Must return a number representing the offset (in pixels);
suppress-warnings - if set, warnings are not rendered at the top of documentation (they still are logged to the console).
lazy-rendering - if set, enables lazy rendering mode in ReDocEx. This mode is useful for APIs with big number of operations (e.g. > 50). In this mode ReDoc shows initial screen ASAP and then renders the rest operations asynchronously while showing progress bar on the top. Check out the demo for the example.
hide-hostname - if set, the protocol and hostname is not shown in the operation definition.
expand-responses - specify which responses to expand by default by response codes. Values should be passed as comma-separated list without spaces e.g. expand-responses="200,201". Special value "all" expands all responses by default. Be careful: this option can slow-down documentation rendering time.
required-props-first - show required properties first ordered in the same order as in required array.
no-auto-auth - do not inject Authentication section automatically
path-in-middle-panel - show path link and HTTP verb in the middle panel instead of the right one

Advanced usage

Instead of adding spec-url attribute to the <redoc-ex> element you can initialize ReDocEx via globally exposed RedocEx object:

RedocEx.init(specOrSpecUrl, options)

specOrSpecUrl is either JSON object with specification or an URL to the spec in JSON or YAML format. options is javascript object with camel-cased version of <redoc-ex> tag attribute names as the keys, e.g.:

RedocEx.init('http://petstore.swagger.io/v2/swagger.json', {
  scrollYOffset: 50
})

Development

Running local dev-server

Clone repository git clone https://github.com/wizspark/redoc-ex.git
Go to the project folder cd redoc-ex
Install dependencies npm install
(optional) Replace demo/swagger.yaml with your own schema
Start the server npm start
Open http://localhost:9000

Alternatively, Docker can be used by just running docker-compose up.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme