JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 55447
  • Score
    100M100P100Q152093F
  • License MIT

Express Middleware for OpenAPI/Swagger-generated API Reference Documentation

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (redoc-express) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    redoc-express

    Express Middleware for OpenAPI/Swagger-generated API Reference Documentation

    code style: prettier npm contributions welcome License: MIT

    Demo

    Install

    npm install redoc-express

    Usage

    const express = require('express');
    const redoc = require('redoc-express');
    
    const app = express();
    const port = 3000;
    
    // serve your swagger.json file
    app.get('/docs/swagger.json', (req, res) => {
      res.sendFile('swagger.json', { root: '.' });
    });
    
    // define title and specUrl location
    // serve redoc
    app.get(
      '/docs',
      redoc({
        title: 'API Docs',
        specUrl: '/docs/swagger.json',
        nonce: '', // <= it is optional,we can omit this key and value
        // we are now start supporting the redocOptions object
        // you can omit the options object if you don't need it
        // https://redocly.com/docs/api-reference-docs/configuration/functionality/
        redocOptions: {
          theme: {
            colors: {
              primary: {
                main: '#6EC5AB'
              }
            },
            typography: {
              fontFamily: `"museo-sans", 'Helvetica Neue', Helvetica, Arial, sans-serif`,
              fontSize: '15px',
              lineHeight: '1.5',
              code: {
                code: '#87E8C7',
                backgroundColor: '#4D4D4E'
              }
            },
            menu: {
              backgroundColor: '#ffffff'
            }
          }
        }
      })
    );
    
    app.listen(port, () => console.log(`Example app listening on port ${port}!`));

    Development

    Install Dependencies

    npm i

    Run Test

    npm t

    Check ReDoc Project for more INFO

    License

    MIT © Aung Myo Kyaw