hapi-docs/lib/routes.js

api plugin to document hapi routes

const joi = require('joi');

module.exports = function(server, options, meta) {
  const unsortedRoutes = server.table().reduce((memo, route) => {
    // '?tags=tag1,tag21' will only look at routes that are tagged as tag1 or tag2:
    if (options.tags && options.tags.split(',').every((tag) => !route.settings.tags || !route.settings.tags.includes(tag))) {
      return memo;
    }
    // don't add the documentation endpoint:
    if (route.path === options.docsEndpoint) {
      return memo;
    }
    // all routes have path and method:
    const routeInfo = {
      path: route.path,
      method: route.method
    };
    // some other additional info that routes may or may not have:
    // if there is a global auth then all routes by default use it:
    if (server.auth.settings.default) {
      routeInfo.auth = server.auth.settings.default;
    }
    // if there is a locally-configed auth show both local and overridden auth:
    if (route.settings.auth) {
      if (routeInfo.auth) {
        routeInfo.overriddenAuth = routeInfo.auth;
      }
      routeInfo.auth = route.settings.auth;
    }
    if (route.settings.tags) {
      routeInfo.tags = route.settings.tags;
    }
    if (route.settings.notes) {
      routeInfo.notes = route.settings.notes;
    }
    const routePluginInfo = route.settings.plugins['hapi-api-docs'] || {};
    // if you need to manually validate inside the code of the route handler,
    // you can still describe a validation schema for hapi-api-docs. Otherwise
    // it will just try to include the one specified in config.validate:
    const validationSpecs = routePluginInfo.validate || route.settings.validate;
    // validation specs will be returned for payload and query:
    if (validationSpecs) {
      if (validationSpecs.payload) {
        routeInfo.payload = joi.describe(validationSpecs.payload);
      }
      if (validationSpecs.query) {
        routeInfo.query = joi.describe(validationSpecs.query);
      }
    }
    if (meta.routes && meta.routes[routeInfo.path]) {
      Object.assign(routeInfo, meta.routes[routeInfo.path]);
    }
    memo.push(routeInfo);
    return memo;
  }, []);
  // routes will be sorted alphabetically
  return unsortedRoutes.sort((a, b) =>
    a.path.toLowerCase().toLowerCase().localeCompare(b.path.toLowerCase()));
};