2018-03-17 20:56:08 +03:00
< div align = "center" >
2019-06-04 15:47:22 +03:00
< img alt = "ReDoc logo" src = "https://raw.githubusercontent.com/Redocly/redoc/master/docs/images/redoc-logo.png" width = "400px" / >
2016-07-28 20:17:56 +03:00
2018-03-17 20:56:08 +03:00
**OpenAPI/Swagger-generated API Reference Documentation**
2016-01-17 23:19:34 +03:00
2019-06-04 15:47:22 +03:00
[![Build Status ](https://travis-ci.org/Redocly/redoc.svg?branch=master )](https://travis-ci.org/Redocly/redoc) [![Coverage Status ](https://coveralls.io/repos/Redocly/redoc/badge.svg?branch=master&service=github )](https://coveralls.io/github/Redocly/redoc?branch=master) [![dependencies Status ](https://david-dm.org/Redocly/redoc/status.svg )](https://david-dm.org/Redocly/redoc) [![devDependencies Status ](https://david-dm.org/Redocly/redoc/dev-status.svg )](https://david-dm.org/Redocly/redoc#info=devDependencies) [![npm ](http://img.shields.io/npm/v/redoc.svg )](https://www.npmjs.com/package/redoc) [![License ](https://img.shields.io/npm/l/redoc.svg )](https://github.com/Redocly/redoc/blob/master/LICENSE)
2016-11-02 14:57:49 +03:00
2021-01-08 16:07:46 +03:00
[![bundle size ](http://img.badgesize.io/https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js?compression=gzip&max=300000 )](https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js) [![npm ](https://img.shields.io/npm/dm/redoc.svg )](https://www.npmjs.com/package/redoc) [![ ](https://data.jsdelivr.com/v1/package/npm/redoc/badge )](https://www.jsdelivr.com/package/npm/redoc) [![Docker Build Status ](https://img.shields.io/docker/build/redocly/redoc.svg )](https://hub.docker.com/r/redocly/redoc/) [![CI Score ](https://meercode.io/badge/Redocly/redoc?type=ci-score )](https://meercode.io/Redocly/redoc)
2018-03-21 18:32:28 +03:00
< / div >
2016-07-28 19:58:04 +03:00
2019-06-04 15:47:22 +03:00
**This is README for `2.0` version of ReDoc (React based). README for `1.x` version is on the branch [v1.x ](https://github.com/Redocly/redoc/tree/v1.x )**
2017-10-12 00:01:37 +03:00
2019-06-04 15:47:22 +03:00
![ReDoc demo ](https://raw.githubusercontent.com/Redocly/redoc/master/demo/redoc-demo.png )
2016-07-28 19:58:04 +03:00
2019-06-04 15:47:22 +03:00
## [Live demo](http://redocly.github.io/redoc/)
2015-11-14 19:43:07 +03:00
2017-08-28 12:33:26 +03:00
[<img alt="Deploy to Github" src="http://i.imgur.com/YZmaqk3.png" height="60px"> ](https://github.com/Rebilly/generator-openapi-repo#generator-openapi-repo-- ) [<img alt="ReDoc as a service" src="http://i.imgur.com/edqdCv6.png" height="60px"> ](https://redoc.ly ) [<img alt="Customization services" src="http://i.imgur.com/c4sUF7M.png" height="60px"> ](https://redoc.ly/#services )
2016-11-29 20:11:39 +03:00
2016-08-01 08:15:52 +03:00
## Features
- Extremely easy deployment
2019-06-04 15:47:22 +03:00
- [redoc-cli ](https://github.com/Redocly/redoc/blob/master/cli/README.md ) with ability to bundle your docs into **zero-dependency** HTML file
2018-03-21 18:58:01 +03:00
- Server Side Rendering ready
2017-09-11 22:10:37 +03:00
- The widest OpenAPI v2.0 features support (yes, it supports even `discriminator` ) < br >
2017-01-31 13:09:46 +03:00
![](docs/images/discriminator-demo.gif)
2018-03-21 18:58:01 +03:00
- OpenAPI 3.0 support
2017-01-31 13:09:46 +03:00
- Neat **interactive** documentation for nested objects < br >
![](docs/images/nested-demo.gif)
- Code samples support (via vendor extension) < br >
![](docs/images/code-samples-demo.gif)
2016-08-01 08:15:52 +03:00
- Responsive three-panel design with menu/scrolling synchronization
2017-01-31 13:09:46 +03:00
- Integrate API Introduction into side menu - ReDoc takes advantage of markdown headings from OpenAPI description field. It pulls them into side menu and also supports deep linking.
- High-level grouping in side-menu via [`x-tagGroups` ](docs/redoc-vendor-extensions.md#x-tagGroups ) vendor extension
2018-03-21 18:58:01 +03:00
- Simple integration with `create-react-app` ([sample](https://github.com/APIs-guru/create-react-app-redoc))
2018-05-03 11:46:30 +03:00
- Branding/customizations via [`theme` option ](#redoc-options-object )
2016-08-01 08:15:52 +03:00
2016-07-28 21:36:43 +03:00
## Roadmap
2019-06-04 15:47:22 +03:00
- [x] ~~[OpenAPI v3.0 support](https://github.com/Redocly/redoc/issues/312)~~
2017-02-09 16:32:47 +03:00
- [x] ~~performance optimizations~~
- [x] ~~better navigation (menu improvements + search)~~
2017-11-23 12:57:07 +03:00
- [x] ~~React rewrite~~
2018-03-17 20:56:08 +03:00
- [x] ~~docs pre-rendering (performance and SEO)~~
2016-12-02 09:00:14 +03:00
- [ ] ability to simple branding/styling
2016-07-28 21:54:58 +03:00
- [ ] built-in API Console
2016-07-28 19:58:04 +03:00
2016-07-28 21:36:43 +03:00
## Releases
2018-03-21 21:30:18 +03:00
**Important:** all the 2.x releases are deployed to npm and can be used via jsdeliver:
- particular release, e.g. `v2.0.0-alpha.15` : https://cdn.jsdelivr.net/npm/redoc@2.0.0-alpha.17/bundles/redoc.standalone.js
- `next` release: https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js
2017-11-23 12:57:07 +03:00
2019-06-04 15:47:22 +03:00
Additionally, all the 1.x releases are hosted on our GitHub Pages-based CDN ** (deprecated)**:
2016-08-30 21:29:22 +03:00
- particular release, e.g. `v1.2.0` : https://rebilly.github.io/ReDoc/releases/v1.2.0/redoc.min.js
- `v1.x.x` release: https://rebilly.github.io/ReDoc/releases/v1.x.x/redoc.min.js
2017-11-23 12:57:07 +03:00
- `latest` release: https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js - it will point to latest 1.x.x release since 2.x releases are not hosted on this CDN but on unpkg.
2016-07-28 19:58:04 +03:00
2017-09-11 22:10:37 +03:00
## Version Guidance
| ReDoc Release | OpenAPI Specification |
|:--------------|:----------------------|
2017-11-23 12:57:07 +03:00
| 2.0.0-alpha.x | 3.0, 2.0 |
2017-09-21 18:22:24 +03:00
| 1.19.x | 2.0 |
2017-09-11 22:10:37 +03:00
| 1.18.x | 2.0 |
| 1.17.x | 2.0 |
2017-02-14 13:18:34 +03:00
## Some Real-life usages
2020-12-10 13:38:12 +03:00
- [Rebilly ](https://api-reference.rebilly.com/ )
2017-02-14 13:18:34 +03:00
- [Docker Engine ](https://docs.docker.com/engine/api/v1.25/ )
- [Zuora ](https://www.zuora.com/developer/api-reference/ )
2017-06-01 17:19:19 +03:00
- [Discourse ](http://docs.discourse.org )
2020-03-17 17:46:43 +03:00
- [Commbox ](https://www.commbox.io/api/ )
2017-02-14 13:18:34 +03:00
- [APIs.guru ](https://apis.guru/api-doc/ )
2018-12-24 12:25:31 +03:00
- [FastAPI ](https://github.com/tiangolo/fastapi )
2017-02-14 13:18:34 +03:00
2016-01-25 00:15:50 +03:00
## Deployment
2016-07-28 21:36:43 +03:00
### TL;DR
2016-07-29 13:39:09 +03:00
2016-01-25 00:15:50 +03:00
```html
<!DOCTYPE html>
< html >
< head >
< title > ReDoc< / title >
<!-- needed for adaptive design -->
2017-02-27 19:00:55 +03:00
< meta charset = "utf-8" / >
2016-01-25 00:15:50 +03:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
2017-11-23 12:57:07 +03:00
< link href = "https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel = "stylesheet" >
2016-01-25 00:15:50 +03:00
<!--
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 >
2016-07-28 21:36:43 +03:00
< redoc spec-url = 'http://petstore.swagger.io/v2/swagger.json' > < / redoc >
2018-03-21 21:30:18 +03:00
< script src = "https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js" > < / script >
2016-01-25 00:15:50 +03:00
< / body >
< / html >
```
2016-07-29 13:39:09 +03:00
That's all folks!
2016-01-25 00:15:50 +03:00
2018-05-03 11:46:30 +03:00
**IMPORTANT NOTE:** if you work with untrusted user spec, use `untrusted-spec` [option ](#redoc-options-object ) to prevent XSS security risks.
2017-05-12 12:51:22 +03:00
2016-07-28 19:58:04 +03:00
### 1. Install ReDoc (skip this step for CDN)
2020-03-17 12:06:03 +03:00
Install using [npm ](https://docs.npmjs.com/getting-started/what-is-npm ):
2016-01-25 00:15:50 +03:00
2020-03-17 12:06:03 +03:00
npm i redoc
2016-01-25 00:15:50 +03:00
2020-03-17 12:06:03 +03:00
or using [yarn ](https://yarnpkg.com ):
2016-01-25 00:15:50 +03:00
2020-03-17 12:06:03 +03:00
yarn add redoc
2016-01-25 00:15:50 +03:00
2016-07-28 21:36:43 +03:00
### 2. Reference redoc script in HTML
2016-07-28 20:17:56 +03:00
For **CDN** :
2016-07-28 19:58:04 +03:00
```html
2018-03-21 18:32:28 +03:00
< script src = "https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js" > < / script >
2016-07-28 19:58:04 +03:00
```
2016-01-25 00:15:50 +03:00
For npm:
```html
2017-11-23 12:57:07 +03:00
< script src = "node_modules/redoc/bundles/redoc.standalone.js" > < / script >
2016-01-25 00:15:50 +03:00
```
2016-07-28 21:36:43 +03:00
### 3. Add `<redoc>` element to your page
2016-01-25 00:15:50 +03:00
```html
2016-07-28 21:54:58 +03:00
< redoc spec-url = "url/to/your/spec" > < / redoc >
2016-01-25 00:15:50 +03:00
```
2016-07-28 21:36:43 +03:00
### 4. Enjoy :smile:
2016-01-25 00:15:50 +03:00
2017-11-23 12:57:07 +03:00
## Usage as a React component
2018-10-04 11:15:55 +03:00
Install peer dependencies required by ReDoc if you don't have them installed already:
2020-10-13 14:56:53 +03:00
npm i react react-dom mobx styled-components core-js
2017-11-23 12:57:07 +03:00
Import `RedocStandalone` component from 'redoc' module:
```js
import { RedocStandalone } from 'redoc';
```
and use it somewhere in your component:
```js
< RedocStandalone specUrl = "url/to/your/spec" / >
```
or
```js
< RedocStandalone spec = {/* spec as an object * / } / >
```
Also you can pass options:
```js
< RedocStandalone
2019-01-10 11:03:41 +03:00
specUrl="http://rebilly.github.io/RebillyAPI/openapi.json"
2017-11-23 12:57:07 +03:00
options={{
nativeScrollbars: true,
2019-05-22 09:37:42 +03:00
theme: { colors: { primary: { main: '#dd5522' } } },
2017-11-23 12:57:07 +03:00
}}
/>
```
Here are detailed [options docs ](#redoc-options-object ).
2018-06-25 13:56:52 +03:00
You can also specify `onLoaded` callback which will be called each time Redoc has been fully rendered or when error occurs (with an error as the first argument). *NOTE* : It may be called multiply times if you change component properties
```js
< RedocStandalone
2019-01-10 11:03:41 +03:00
specUrl="http://rebilly.github.io/RebillyAPI/openapi.json"
2018-06-25 13:56:52 +03:00
onLoaded={error => {
if (!error) {
console.log('Yay!');
}
}}
/>
```
2019-05-12 23:15:44 +03:00
[**IE11 Support Notes** ](docs/usage-with-ie11.md )
2018-10-18 18:27:31 +03:00
## The Docker way
ReDoc is available as pre-built Docker image in official [Docker Hub repository ](https://hub.docker.com/r/redocly/redoc/ ). You may simply pull & run it:
docker pull redocly/redoc
2018-11-05 17:44:44 +03:00
docker run -p 8080:80 redocly/redoc
2018-10-18 18:27:31 +03:00
2018-11-14 15:37:14 +03:00
Also you may rewrite some predefined environment variables defined in [Dockerfile ](./config/docker/Dockerfile ). By default ReDoc starts with demo Petstore spec located at `http://petstore.swagger.io/v2/swagger.json` , but you may change this URL using environment variable `SPEC_URL` :
2018-10-18 18:27:31 +03:00
2018-11-05 17:44:44 +03:00
docker run -p 8080:80 -e SPEC_URL=https://api.example.com/openapi.json redocly/redoc
2018-10-18 18:27:31 +03:00
2018-03-15 21:56:11 +03:00
## ReDoc CLI
2019-06-04 15:47:22 +03:00
[See here ](https://github.com/Redocly/redoc/blob/master/cli/README.md )
2018-03-15 21:56:11 +03:00
2016-01-25 00:15:50 +03:00
## Configuration
2016-10-31 13:32:17 +03:00
### Security Definition location
You can inject Security Definitions widget into any place of your specification `description` . Check out details [here ](docs/security-definitions-injection.md ).
2016-07-28 21:36:43 +03:00
### Swagger vendor extensions
2018-11-30 11:09:40 +03:00
ReDoc makes use of the following [vendor extensions ](https://swagger.io/specification/#specificationExtensions ):
2016-02-01 20:23:13 +03:00
* [`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
2020-05-10 22:11:01 +03:00
* [`x-codeSamples` ](docs/redoc-vendor-extensions.md#x-codeSamples ) - specify operation code samples
2017-03-09 13:55:23 +03:00
* [`x-examples` ](docs/redoc-vendor-extensions.md#x-examples ) - specify JSON example for requests
2019-12-10 09:03:46 +03:00
* [`x-nullable` ](docs/redoc-vendor-extensions.md#x-nullable ) - mark schema param as a nullable
2016-12-11 23:57:22 +03:00
* [`x-displayName` ](docs/redoc-vendor-extensions.md#x-displayname ) - specify human-friendly names for the menu categories
2016-12-26 00:47:33 +03:00
* [`x-tagGroups` ](docs/redoc-vendor-extensions.md#x-tagGroups ) - group tags by categories in the side menu
2017-02-26 00:44:19 +03:00
* [`x-servers` ](docs/redoc-vendor-extensions.md#x-servers ) - ability to specify different servers for API (backported from OpenAPI 3.0)
2017-09-21 01:18:38 +03:00
* [`x-ignoredHeaderParameters` ](docs/redoc-vendor-extensions.md#x-ignoredHeaderParameters ) - ability to specify header parameter names to ignore
2019-06-18 11:41:48 +03:00
* [`x-additionalPropertiesName` ](docs/redoc-vendor-extensions.md#x-additionalPropertiesName ) - ability to supply a descriptive name for the additional property keys
2020-11-10 11:21:02 +03:00
* [`x-summary` ](docs/redoc-vendor-extensions.md#x-summary ) - For Response object, use as the response button text, with description rendered under the button
* [`x-extendedDiscriminator` ](docs/redoc-vendor-extensions.md#x-extendedDiscriminator ) - In Schemas, uses this to solve name-clash issues with the standard discriminator
* [`x-explicitMappingOnly` ](docs/redoc-vendor-extensions.md#x-explicitMappingOnly ) - In Schemas, display a more descriptive property name in objects with additionalProperties when viewing the property list with an object
2016-02-01 20:23:13 +03:00
2017-11-23 12:57:07 +03:00
### `<redoc>` options object
2018-05-03 11:46:30 +03:00
You can use all of the following options with standalone version on < redoc > tag by kebab-casing them, e.g. `scrollYOffset` becomes `scroll-y-offset` and `expandResponses` becomes `expand-responses` .
2017-11-23 12:57:07 +03:00
2019-10-16 15:58:02 +03:00
* `disableSearch` - disable search indexing and search box.
* `expandDefaultServerVariables` - enable expanding default server variables, default `false` .
2017-11-23 12:57:07 +03:00
* `expandResponses` - specify which responses to expand by default by response codes. Values should be passed as comma-separated list without spaces e.g. `expandResponses="200,201"` . Special value `"all"` expands all responses by default. Be careful: this option can slow-down documentation rendering time.
2020-10-27 11:54:08 +03:00
* `maxDisplayedEnumValues` - display only specified number of enum values. hide rest values under spoiler.
2018-03-21 18:32:28 +03:00
* `hideDownloadButton` - do not show "Download" spec button. **THIS DOESN'T MAKE YOUR SPEC PRIVATE** , it just hides the button.
2019-10-16 15:58:02 +03:00
* `hideHostname` - if set, the protocol and hostname is not shown in the operation definition.
* `hideLoading` - do not show loading animation. Useful for small docs.
2020-11-30 12:54:46 +03:00
* `hideSchemaPattern` - if set, the pattern is not shown in the schema.
2019-10-16 15:58:02 +03:00
* `hideSingleRequestSampleTab` - do not show the request sample tab for requests with only one sample.
2020-03-13 19:23:24 +03:00
* `expandSingleSchemaField` - automatically expand single field in a schema
2019-07-29 15:26:16 +03:00
* `jsonSampleExpandLevel` - set the default expand level for JSON payload samples (responses and request body). Special value 'all' expands all levels. The default value is `2` .
2020-08-04 12:19:49 +03:00
* `hideSchemaTitles` - do not display schema `title` next to to the type
* `simpleOneOfTypeLabel` - show only unique oneOf types in the label without titles
2019-10-16 15:58:02 +03:00
* `lazyRendering` - _Not implemented yet_ ~~if set, enables lazy rendering mode in ReDoc. 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](\\redocly.github.io/redoc) for the example.~~
2020-12-01 16:24:20 +03:00
* `menuToggle` - if true clicking second time on expanded menu item will collapse it, default `true` .
2019-10-16 15:58:02 +03:00
* `nativeScrollbars` - use native scrollbar for sidemenu instead of perfect-scroll (scrolling performance optimization for big specs).
* `noAutoAuth` - do not inject Authentication section automatically.
* `onlyRequiredInSamples` - shows only required fields in request samples.
* `pathInMiddlePanel` - show path link and HTTP verb in the middle panel instead of the right one.
* `requiredPropsFirst` - show required properties first ordered in the same order as in `required` array.
* `scrollYOffset` - 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;
`scrollYOffset` 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).
* `showExtensions` - show vendor extensions ("x-" fields). Extensions used by ReDoc are ignored. Can be boolean or an array of `string` with names of extensions to display.
* `sortPropsAlphabetically` - sort properties alphabetically.
* `suppressWarnings` - if set, warnings are not rendered at the top of documentation (they still are logged to the console).
2019-12-12 20:08:05 +03:00
* `payloadSampleIdx` - if set, payload sample will be inserted at this index or last. Indexes start from 0.
2021-01-08 15:05:10 +03:00
* `theme` - ReDoc theme. For details check [theme docs ](#redoc-theme-object ).
2019-10-16 15:58:02 +03:00
* `untrustedSpec` - if set, the spec is considered untrusted and all HTML/markdown is sanitized to prevent XSS. **Disabled by default** for performance reasons. **Enable this option if you work with untrusted user data!**
2017-11-23 12:57:07 +03:00
2021-01-08 15:05:10 +03:00
### `<redoc>` theme object
* `spacing`
* `unit` : 5 # main spacing unit used in autocomputed theme values later
* `sectionHorizontal` : 40 # Horizontal section padding. COMPUTED: spacing.unit * 8
* `sectionVertical` : 40 # Horizontal section padding. COMPUTED: spacing.unit * 8
* `breakpoints` # breakpoints for switching three/two and mobile view layouts
* `small` : '50rem'
* `medium` : '85rem'
* `large` : '105rem'
* `colors`
* `tonalOffset` : 0.3 # default tonal offset used in computations
* `typography`
* `fontSize` : '14px'
* `lineHeight` : '1.5em'
* `fontWeightRegular` : '400'
* `fontWeightBold` : '600'
* `fontWeightLight` : '300'
* `fontFamily` : 'Roboto, sans-serif'
* `smoothing` : 'antialiased'
* `optimizeSpeed` : true
* `headings`
* `fontFamily` : 'Montserrat, sans-serif'
* `fontWeight` : '400'
* `lineHeight` : '1.6em'
* `code` # inline code styling
* `fontSize` : '13px'
* `fontFamily` : 'Courier, monospace'
* `lineHeight` : # COMPUTED: typography.lineHeight
* `fontWeight` : # COMPUTED: typography.fontWeightRegular
* `color` : '#e53935'
* `backgroundColor` : 'rgba(38, 50, 56, 0.05)'
* `wrap` : false # whether to break word for inline blocks (otherwise they can overflow)
* `links`
* `color` : # COMPUTED: colors.primary.main
* `visited` : # COMPUTED: typography.links.color
* `hover` : # COMPUTED: lighten(0.2 typography.links.color)
* `menu`
* `width` : '260px'
* `backgroundColor` : '#fafafa'
* `textColor` : '#333333'
* `activeTextColor` : # COMPUTED: theme.menu.textColor (if set by user) or theme.colors.primary.main
* `groupItems` # Group headings
* `textTransform` : 'uppercase'
* `level1Items` # Level 1 items like tags or section 1st level items
* `textTransform` : 'none'
* `arrow` # menu arrow
* `size` : '1.5em'
* `color` : # COMPUTED: theme.menu.textColor
* `logo`
* `maxHeight` : # COMPUTED: menu.width
* `maxWidth` : # COMPUTED: menu.width
* `gutter` : '2px' # logo image padding
* `rightPanel`
* `backgroundColor` : '#263238'
* `width` : '40%'
* `textColor` : '#ffffff'
2017-11-23 12:57:07 +03:00
## Advanced usage of standalone version
2016-01-25 00:15:50 +03:00
Instead of adding `spec-url` attribute to the `<redoc>` element you can initialize ReDoc via globally exposed `Redoc` object:
```js
2018-06-01 18:37:35 +03:00
Redoc.init(specOrSpecUrl, options, element, callback?)
2016-01-25 00:15:50 +03:00
```
2017-11-23 12:57:07 +03:00
- `specOrSpecUrl` is either JSON object with specification or an URL to the spec in `JSON` or `YAML` format
- `options` [options object ](#redoc-options-object )
- `element` DOM element to put ReDoc into
2018-06-25 13:56:52 +03:00
- `callback` (optional) - callback to be called after Redoc has been fully rendered. It is also called also on errors with error as the first argument
2017-11-23 12:57:07 +03:00
2016-01-25 00:15:50 +03:00
```js
Redoc.init('http://petstore.swagger.io/v2/swagger.json', {
scrollYOffset: 50
2017-11-23 12:57:07 +03:00
}, document.getElementById('redoc-container'))
2016-01-25 00:15:50 +03:00
```
2016-07-29 18:20:38 +03:00
2016-01-25 00:15:50 +03:00
-----------
2016-08-23 01:04:10 +03:00
## Development
2018-10-03 10:02:30 +03:00
see [CONTRIBUTING.md ](.github/CONTRIBUTING.md )