Files middleware

Serves your Swagger API file(s) so they can be used with front-end tools like like Swagger UI, Swagger Editor, and Postman.

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 express = require('express');
const createMiddleware = require('@apidevtools/swagger-express-middleware');

let app = express();

createMiddleware('PetStore.yaml', app, function(err, middleware) {
    // Add the Files middleware to the Express app
    app.use(middleware.files({
        // Change the URL of the raw Swagger files
        rawFilesPath: '/my/custom/path'
    }));

    app.listen(8000, function() {
        console.log('Go to to http://localhost:8000/my/custom/path/PetStore.yaml');
    });
});

Run the above example and then browse to http://localhost:8000/api-docs/ and http://localhost:8000/my/custom/path/PetStore.yaml. The first URL will return the Swagger API in JSON. The second URL will return the raw PetStore.yaml file. Note that the second URL’s path has been customized in the example code.

Options

middleware.files(router, options)

This is the function you call to create the Files middleware. All of its parameters are optional.

• 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.

• options (optional) - object
  This parameter allows you to change the paths at which the files are served. It is an object with the following properties: