redoc-express

Express Middleware for OpenAPI/Swagger-generated API Reference Documentation

Demo

• Live Demo

Install

1npm install redoc-express

Usage

1const express = require('express');
2const redoc = require('redoc-express');
3
4const app = express();
5const port = 3000;
6
7// serve your swagger.json file
8app.get('/docs/swagger.json', (req, res) => {
9  res.sendFile('swagger.json', { root: '.' });
10});
11
12// define title and specUrl location
13// serve redoc
14app.get(
15  '/docs',
16  redoc({
17    title: 'API Docs',
18    specUrl: '/docs/swagger.json',
19    nonce: '', // <= it is optional,we can omit this key and value
20    // we are now start supporting the redocOptions object
21    // you can omit the options object if you don't need it
22    // https://redocly.com/docs/api-reference-docs/configuration/functionality/
23    redocOptions: {
24      theme: {
25        colors: {
26          primary: {
27            main: '#6EC5AB'
28          }
29        },
30        typography: {
31          fontFamily: `"museo-sans", 'Helvetica Neue', Helvetica, Arial, sans-serif`,
32          fontSize: '15px',
33          lineHeight: '1.5',
34          code: {
35            code: '#87E8C7',
36            backgroundColor: '#4D4D4E'
37          }
38        },
39        menu: {
40          backgroundColor: '#ffffff'
41        }
42      }
43    }
44  })
45);
46
47app.listen(port, () => console.log(`Example app listening on port ${port}!`));

Development

Install Dependencies

1npm i

Run Test

1npm t

Check ReDoc Project for more INFO

• redoc

License

MIT © Aung Myo Kyaw