About This Package

This package contains a single swagger-ui-express middleware, including swagger.json and swagger.yaml config files, for a backend signup API project in the Programming for Web Applications class at Full Sail University.

Installation via NPM

npm install @erikbrandon-fs/docs

Usage

// Step 1 - Destructure the docsRouter middleware in a require or import statement.

// JavaScript
const { docsRouter } = require('@erikbrandon-fs/docs');

// TypeScript
import { docsRouter } from '@erikbrandon-fs/docs';

// Step 2 - Add the docsRouter as a middleware to your Express app.
app.use(docsRouter);

// Step 3 - Run your project and visit the /docs endpoint in your browser to see the swagger documentation.