Metadata middleware

Annotates each request with all the relevant information from the Swagger definition. The path, the operation, the parameters, the security requirements - they’re all easily accessible at req.swagger.

Example

This example uses the PetStore.yaml sample Swagger API. If you aren’t familiar with using middleware in Express.js, then read this first.

const util = require('util');
const express = require('express');
const createMiddleware = require('@apidevtools/swagger-express-middleware');

let app = express();

createMiddleware('PetStore.yaml', app, function(err, middleware) {
    // Add the Metadata middleware to the Express app
    app.use(middleware.metadata());

    // Add middleware to display the Swagger metadata as HTML
    app.use(function(req, res, next) {
        res.type('html');
        res.send(util.format('<h1>%s has %d parameters</h1><pre>%s</pre>',
            req.swagger.pathName,
            req.swagger.params.length,
            util.inspect(req.swagger.params)
        ));
    });

    app.listen(8000, function() {
        console.log('Go to http://localhost:8000/pets/Fido/photos/12345');
    });
});

Run the above example and then try browsing to http://localhost:8000/pets/Fido and http://localhost:8000/pets/Fido/photos/12345. You will see different metadata for each path.

Options

middleware.metadata(router)

This is the function you call to create the metadata middleware.

• router (optional) - express.App or express.Router
  An Express Application or Router that will be used to determine settings (such as case-sensitivity and strict routing).
  
  All Swagger Express Middleware modules accept this optional first parameter. Rather than passing it to each middleware, you can just pass it to the createMiddleware function (as shown in the example above) and all middleware will use it.

API

req.swagger

A swagger property is added to the Request object. It’s an object with the following properties: