hapi-swagger-static/src/index.js

A small companion plugin for `hapi-swagger` or `hapi-swaggered` providing a static html documentation page as hapi route

const SwaggerParser = require('swagger-parser');
const openapi2html = require('openapi2html');
const util = require('util');
const fs = require('fs');
const path = require('path');
const pkg = require('../package.json');

const readFile = util.promisify(fs.readFile);

const register = async (server, {
  path: route = '/documentation.html',
  swaggerEndpoint = '/swagger.json',
  cache = { privacy: 'public', expiresIn: 60 * 60 * 1000 }, // one hour
  auth, // if undefined, inheriting auth settings from server.options.routes.auth
  headers: additionalHeaders = {},
  template,
  viewOptions = {},
  o2hOptions = {},
}) => {
  server.route({
    method: 'GET',
    path: route,
    options: auth === undefined ? { cache } : { cache, auth },
    handler: async (request, h) => {
      try {
        const response = await server.inject({
          url: swaggerEndpoint,
          headers: {
            authorization: request.headers.authorization, // forward
            ...additionalHeaders,
          },
        });
        const { payload } = response;
        const swaggerObject = JSON.parse(payload);
        const parser = new SwaggerParser();
        const api = await parser.parse(swaggerObject, {
          resolve: {
            file: false, // don't resolve local file references
            http: {
              timeout: 2000,
              withCredentials: true, // include auth credentials when resolving HTTP references
              headers: {
                authorization: request.headers.authorization, // forward
                ...additionalHeaders,
              },
            },
          },
        });
        const html = openapi2html(api, o2hOptions);
        // the preferred way is to render the page via `view`
        if (h.view && template) {
          return h.view(template, { api: { ...api, html } }, viewOptions);
        }
        // as a fallback, use own template
        const frame = await readFile(path.join(__dirname, 'frame.html'), 'UTF-8');
        const page = frame
          .replace(/\{\{content\}\}/, html)
          .replace(/\{\{title\}\}/, api.info.title);
        return h.response(page).type('text/html').charset('utf-8');
      } catch (error) {
        request.log(['error'], error);
        throw error; // -> http 500
      }
    },
  });
};

module.exports = { register, pkg };