2015-10-30 15:53:02 +03:00
# ReDoc
2016-06-09 20:39:52 +03:00
[](https://travis-ci.org/Rebilly/ReDoc) [](https://coveralls.io/github/Rebilly/ReDoc?branch=master) [](https://APIs.guru) [](https://codeclimate.com/github/Rebilly/ReDoc) [](https://david-dm.org/Rebilly/ReDoc#info=devDependencies) [](https://waffle.io/Rebilly/ReDoc)
2016-01-17 23:19:34 +03:00
2016-03-13 03:48:17 +03:00
[](https://www.npmjs.com/package/redoc) [](http://bower.io/) [](https://github.com/Rebilly/ReDoc/blob/master/LICENSE)
2016-01-17 23:19:34 +03:00
[](https://saucelabs.com/u/redoc)
2015-11-14 19:43:07 +03:00
2015-10-30 15:53:02 +03:00
Swagger-generated API Reference Documentation
2015-11-14 19:43:07 +03:00
2016-07-28 19:58:04 +03:00
2016-01-17 23:19:34 +03:00
[Live demo ](http://rebilly.github.io/ReDoc/ )
2015-11-14 19:43:07 +03:00
2016-07-28 19:58:04 +03:00
## CDN
- latest release: https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js
- particular release, e.g. v0.16.1: https://rebilly.github.io/ReDoc/releases/v0.16.0/redoc.min.js
2016-01-25 00:15:50 +03:00
## Deployment
2016-01-25 02:22:25 +03:00
#### tl;dr
2016-01-25 00:15:50 +03:00
```html
<!DOCTYPE html>
< html >
< head >
< title > ReDoc< / title >
<!-- needed for adaptive design -->
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
<!--
2016-07-28 15:56:14 +03:00
ReDoc doesn't change outer page styles
2016-01-25 00:15:50 +03:00
-->
< style >
body {
margin: 0;
padding: 0;
}
< / style >
< / head >
< body >
< redoc spec-url = 'http://petstore.swagger.io/v2/swagger.json' >
< / redoc >
2016-07-28 19:58:04 +03:00
< script src = "https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js" > < / script >
2016-01-25 00:15:50 +03:00
< / body >
< / html >
```
2016-07-28 19:58:04 +03:00
That's it!
2016-01-25 00:15:50 +03:00
2016-07-28 19:58:04 +03:00
### 1. Install ReDoc (skip this step for CDN)
2016-01-25 00:15:50 +03:00
Install using [bower ](bower.io ):
bower install redoc
or using [npm ](https://docs.npmjs.com/getting-started/what-is-npm ):
npm install redoc --save
2016-06-30 11:34:39 +03:00
Alternatively, you can **reference redoc directly** from CDN:
2016-07-28 19:58:04 +03:00
2016-01-25 00:15:50 +03:00
#### 2. Reference redoc script in HTML
2016-07-28 19:58:04 +03:00
For CDN:
```html
< script src = "https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js" > < / script >
```
For bower:
2016-01-25 00:15:50 +03:00
```html
< script src = "bower_components/redoc/dist/redoc.min.js" > < / script >
```
For npm:
```html
< script src = "node_modules/redoc/dist/redoc.min.js" > < / script >
```
#### 3. Add `<redoc>` element to your page
```html
< redoc spec-url = "<url to your spec>" > < / redoc >
```
#### 4. Enjoy :smile:
## Configuration
2016-02-01 20:23:13 +03:00
#### Swagger vendor extensions
ReDoc makes use of the following [vendor extensions ](http://swagger.io/specification/#vendorExtensions ):
* [`x-logo` ](docs/redoc-vendor-extensions.md#x-logo ) - is used to specify API logo
* [`x-traitTag` ](docs/redoc-vendor-extensions.md#x-traitTag ) - useful for handling out common things like Pagination, Rate-Limits, etc
* [`x-code-samples` ](docs/redoc-vendor-extensions.md#x-code-samples ) - specify operation code samples
#### Options
2016-01-25 00:15:50 +03:00
* `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).
2016-07-27 18:57:23 +03:00
* `suppress-warnings` - if set, warnings are not rendered at the top of page (they still are logged to the console)
2016-01-25 00:15:50 +03:00
## Advanced usage
Instead of adding `spec-url` attribute to the `<redoc>` element you can initialize ReDoc via globally exposed `Redoc` object:
```js
Redoc.init(specUrl, options)
```
2016-01-25 02:22:25 +03:00
`options` is javascript object with camel-cased version of options names as the keys. For example:
2016-01-25 00:15:50 +03:00
```js
Redoc.init('http://petstore.swagger.io/v2/swagger.json', {
scrollYOffset: 50
})
```
-----------
2015-11-14 19:43:07 +03:00
## Running locally
1. Clone repository
`git clone https://github.com/Rebilly/ReDoc.git`
2. Go to the project folder
`cd ReDoc`
2016-02-03 19:49:36 +03:00
3. Install node modules and front-end dependencies
2015-11-14 19:43:07 +03:00
`npm install`
2016-02-03 19:49:36 +03:00
`npm run jspm-install`
2015-11-14 19:43:07 +03:00
4. _(optional)_ Replace `demo/swagger.json` with your own schema
5. Start the server
`npm start`
6. Open `http://localhost:9000`
