mirror of https://github.com/Redocly/redoc.git synced 2024-11-22 08:36:33 +03:00

📘 OpenAPI/Swagger-generated API Reference Documentation

api-documentation documentation-generator documentation-tool hacktoberfest openapi openapi3 openapi31 openapi-specification reactjs redoc starred-redocly-repo starred-repo swagger

Go to file

Roman Hotsiy 53b4f55876 Refactor		2016-06-22 21:53:11 +03:00
build	Remove second tsc task from build	2016-06-19 17:40:45 +03:00
demo	Minor demo update	2016-06-22 12:49:30 +03:00
docs	fix backgroundColor in samples	2016-04-22 16:33:27 +03:00
lib	Refactor	2016-06-22 21:53:11 +03:00
tests	Refactor	2016-06-22 21:53:11 +03:00
typings	Replace marked with remarkable	2016-06-22 12:42:24 +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
.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 coveralls report	2016-06-17 12:49:00 +03:00
LICENSE	Update LICENSE	2015-10-30 07:56:43 -05:00
package.json	Replace marked with remarkable	2016-06-22 12:42:24 +03:00
protractor.conf.js	Switch to APIs.guru API v2	2016-06-09 20:40:54 +03:00
README.md	Update APIs.guru URLs in README	2016-06-09 20:39:52 +03:00
rollup.config.js	Migrate to Typescript (not finished yet)	2016-05-25 18:34:31 +03:00
system.config.js	Replace marked with remarkable	2016-06-22 12:42:24 +03:00
tsconfig.json	Fix coverage	2016-06-16 15:44:14 +03:00
tslint.json	Fix lint erorrs, fix typescript version	2016-06-15 21:48:04 +03:00
typings.json	Migrate tests to TypeScript	2016-06-12 20:44:34 +03:00

README.md

ReDoc

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

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