Features

• Quick and easy setup for Swagger in NestJS applications.
• Automatically generates API documentation based on your decorators.
• Highly customizable to fit your application's needs.
• Supports OpenAPI 3.x.

Installation

# Using npm
$ npm install nestjs-quick-swagger --save

# Using yarn
$ yarn add nestjs-quick-swagger

Configuration

SWAGGER env vars

SWAGGER_TITLE="QUICK SWAGGER"

SWAGGER_DESCRIPTION="QUICK SWAGGER API"

SWAGGER_VERSION="1.0"

SWAGGER_TAGS="Template"

SWAGGER_AUTH_USERNAME="test"

SWAGGER_AUTH_PASSWORD="test@123"

SWAGGER_CONTACT_NAME='sandeepmehta.com'

SWAGGER_CONTACT_EMAIL='[email protected]'

SWAGGER_CONTACT_URL='https://sandeepmehta.com/login'

SWAGGER_PROJECT_DETAILS='https://github.com/sandeepmehta2155/discovery-service'

SWAGGER_LOCAL_ENDPOINT='http://localhost:4000/'

SWAGGER_STAG_ENDPOINT='https://sandeepmehta.com/apis'

Usage

const app = await NestFactory.create(AppModule);

SwaggerModule.setup('/apis/docs', app, createDocument(app));

await app.listen(3005);

Resources

Check out a few resources that may come in handy when working with NestJS:

• Visit the NestJS Documentation to learn more about the framework.
• For questions and support, please visit our Discord channel.
• To dive deeper and get more hands-on experience, check out our official video courses.
• Visualize your application graph and interact with the NestJS application in real-time using NestJS Devtools.
• Need help with your project (part-time to full-time)? Check out our official enterprise support.
• To stay in the loop and get updates, follow us on X and LinkedIn.
• Looking for a job, or have a job to offer? Check out our official Jobs board.

Stay in touch

• Author - Sandeep Mehta
• Website - https://nestjs.com