redoc/README.md

142 lines
5.6 KiB
Markdown
Raw Normal View History

2015-10-30 15:53:02 +03:00
# ReDoc
2016-07-28 20:17:56 +03:00
**OpenAPI/Swagger-generated API Reference Documentation**
2016-11-01 17:59:06 +03:00
[![Build Status](https://travis-ci.org/Rebilly/ReDoc.svg?branch=master)](https://travis-ci.org/Rebilly/ReDoc) [![Coverage Status](https://coveralls.io/repos/Rebilly/ReDoc/badge.svg?branch=master&service=github)](https://coveralls.io/github/Rebilly/ReDoc?branch=master) [![Tested on APIs.guru](http://api.apis.guru/badges/tested_on.svg)](https://APIs.guru) [![dependencies Status](https://david-dm.org/Rebilly/ReDoc/status.svg)](https://david-dm.org/Rebilly/ReDoc) [![devDependencies Status](https://david-dm.org/Rebilly/ReDoc/dev-status.svg)](https://david-dm.org/Rebilly/ReDoc#info=devDependencies) [![Stories in Ready](https://badge.waffle.io/Rebilly/ReDoc.png?label=ready&title=Ready)](https://waffle.io/Rebilly/ReDoc)
2016-01-17 23:19:34 +03:00
2016-03-13 03:48:17 +03:00
[![npm](http://img.shields.io/npm/v/redoc.svg)](https://www.npmjs.com/package/redoc) [![Bower](http://img.shields.io/bower/v/redoc.svg)](http://bower.io/) [![License](https://img.shields.io/npm/l/redoc.svg)](https://github.com/Rebilly/ReDoc/blob/master/LICENSE)
2016-01-17 23:19:34 +03:00
[![Browser Compatibility](https://saucelabs.com/browser-matrix/redoc.svg)](https://saucelabs.com/u/redoc)
2015-11-14 19:43:07 +03:00
2016-07-28 19:58:04 +03:00
![ReDoc demo](demo/redoc-demo.png)
2016-07-28 20:17:56 +03:00
## [Live demo](http://rebilly.github.io/ReDoc/)
2015-11-14 19:43:07 +03:00
2016-08-01 08:15:52 +03:00
## Features
- Extremely easy deployment
- Its free and open-source project under MIT license
- The widest OpenAPI features support (yes, it supports even discriminator)
- Neat documentation for nested objects
- Code samples support (via vendor extension)
- Responsive three-panel design with menu/scrolling synchronization
- 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.
2016-07-28 21:36:43 +03:00
## Roadmap
2016-07-28 21:54:58 +03:00
- [ ] docs pre-rendering (performance and SEO)
2016-07-29 13:39:09 +03:00
- [ ] ability to simple customization
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
2016-07-28 21:54:58 +03:00
We host latest and all the previous ReDoc releases on GitHub Pages-based **CDN**:
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
- `latest` release: https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js **[not for production]**
2016-07-28 19:58:04 +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 -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<!--
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>
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-29 13:39:09 +03:00
That's all folks!
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-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
<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>
```
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
## 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
2016-02-01 20:23:13 +03:00
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
2016-08-31 22:45:34 +03:00
* [`x-nullable`](docs/redoc-vendor-extensions.md#nullable) - mark schema param as a nullable
2016-02-01 20:23:13 +03:00
2016-08-04 19:14:50 +03:00
### `<redoc>` tag attributes
2016-07-28 21:54:58 +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;
2016-01-25 00:15:50 +03:00
`scroll-y-offset` can be specified in various ways:
2016-07-28 21:54:58 +03:00
* **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-29 18:20:38 +03:00
* `suppress-warnings` - if set, warnings are not rendered at the top of documentation (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-08-04 19:14:50 +03:00
`options` is javascript object with camel-cased version of `<redoc>` tag attribute names as the keys, e.g.:
2016-01-25 00:15:50 +03:00
```js
Redoc.init('http://petstore.swagger.io/v2/swagger.json', {
scrollYOffset: 50
})
```
2016-07-29 18:20:38 +03:00
2016-01-25 00:15:50 +03:00
-----------
## Development
#### Running local dev-server
2016-09-21 01:28:42 +03:00
- Clone repository
2015-11-14 19:43:07 +03:00
`git clone https://github.com/Rebilly/ReDoc.git`
2016-09-21 01:28:42 +03:00
- Go to the project folder
2015-11-14 19:43:07 +03:00
`cd ReDoc`
2016-09-21 01:28:42 +03:00
- Install dependencies
`npm install`
2016-09-22 10:13:29 +03:00
- _(optional)_ Replace `demo/swagger.yaml` with your own schema
2016-09-21 01:28:42 +03:00
- Start the server
2015-11-14 19:43:07 +03:00
`npm start`
2016-09-21 01:28:42 +03:00
- Open `http://localhost:9000`