📘 OpenAPI/Swagger-generated API Reference Documentation
Go to file
2016-05-20 23:04:11 +03:00
build fix broken unit tests 2016-05-20 22:56:10 +03:00
demo Add gulp copydebug task 2016-05-20 20:51:31 +03:00
docs fix backgroundColor in samples 2016-04-22 16:33:27 +03:00
lib Add version getter to ReDoc runtime 2016-05-20 20:36:26 +03:00
tests Fixed e2e tests (button was not clickable) 2016-05-20 19:51:57 +03:00
.codeclimate.yml fix codeclimate config 2015-12-26 19:47:35 +02:00
.eslintignore Updated eslint 2015-12-12 22:10:59 +02:00
.eslintrc IE10, IE9 Fixes 2016-02-10 13:19:50 +02:00
.gitignore try releases to github pages 2016-04-30 22:55:29 +03:00
.npmignore prepare for npm publish 2016-01-12 23:36:23 +02:00
.travis.yml include basic e2e to the tescases needed for deployment 2016-05-10 11:02:47 +03:00
bower.json Add additional keywords 2016-02-24 18:25:49 +02:00
gulpfile.js Add gulp copydebug task 2016-05-20 20:51:31 +03:00
karma.conf.js fix unit tests: add version.json to karma serveed 2016-05-20 22:45:12 +03:00
LICENSE Update LICENSE 2015-10-30 07:56:43 -05:00
package.json bump version (v0.12.0) 2016-05-20 23:04:11 +03:00
protractor.conf.js Sauce IE fix 2016-05-10 09:43:05 +03:00
README.md Add tested on APIs.guru badge 2016-05-11 15:41:35 +03:00
system.config.js use json-schema-ref-parser instead of SwaggerParser (fixes #46) 2016-05-20 20:13:39 +03:00

ReDoc

Build Status Coverage Status Tested on APIs.guru Code Climate David Stories in Ready

npm Bower License

Browser Compatibility

Swagger-generated API Reference Documentation

Live demo

Deployment

tl;dr

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

    <!--
    ReDoc uses font options from the parent element
    So override default browser styles
    -->
    <style>
      body {
        margin: 0;
        padding: 0;
        font-family: Verdana, Geneva, sans-serif;
        font-size: 14px;
        color: #333;
      }
    </style>
  </head>
  <body>
    <redoc spec-url='http://petstore.swagger.io/v2/swagger.json'>
    </redoc>
    <script src="bower_components/redoc/dist/redoc.min.js"> </script>
  </body>
</html>

1. Install redoc

Install using bower:

bower install redoc

or using npm:

npm install redoc --save

Alternatively you can just download redoc.min.js.

2. Reference redoc script in HTML

Then reference redoc.min.js in your HTML page:

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

For npm:

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

3. Add <redoc> element to your page

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

4. Enjoy 😄

Configuration

Swagger vendor extensions

ReDoc makes use of the following vendor extensions:

  • x-logo - is used to specify API logo
  • x-traitTag - useful for handling out common things like Pagination, Rate-Limits, etc
  • x-code-samples - specify operation code samples

Options

  • 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).

Advanced usage

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

Redoc.init(specUrl, options)

options is javascript object with camel-cased version of options names as the keys. For example:

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

Running locally

  1. Clone repository git clone https://github.com/Rebilly/ReDoc.git
  2. Go to the project folder cd ReDoc
  3. Install node modules and front-end dependencies npm install npm run jspm-install
  4. (optional) Replace demo/swagger.json with your own schema
  5. Start the server npm start
  6. Open http://localhost:9000