Skip to main content

Generate API Documentation Using Swagger Module in NestJS

Swagger provides us a standard to generate API documentation based on the Open API specification. If we use NestJS for building our API providers, we can utilize a tool provided by NestJS in the @nestjs/swagger module to generate the documentation automatically in the built time. This module also requires the swagger-ui-express module if we use Express as the NestJS base HTTP handler.


Set Swagger configuration

First, we need to define Swagger options and instantiate the documentation provider on the main.ts file.

import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';

// sample application instance
const app = await NestFactory.create(AppModule);

// setup Swagger options
const options = new DocumentBuilder()
    .setTitle('Coffee')
    .setVersion('1.0')
    .setDescription('Learn NestJS with coffee')
    .build();

// build the document
const document = SwaggerModule.createDocument(app, options);

// provide an endpoint where the document can be accessed
SwaggerModule.setup('docs', app, document);

Set custom compiler options

NestJS is optimized for us to implement the object validation processes and define the shapes of any objects passed to our API endpoints that are subjected to data transfer objects (DTO). The implementation utilizes Typescript decorators which are not evaluated in the built time if we use the default compiler. To let the Swagger module generates correct definitions of any request payloads, we need to override default compiler options in the nest-cli.json file by enabling the NestJS Swagger plugin.

{
  // ...
  "compilerOptions": {
    "deleteOutDir": true,
    "plugins": ["@nestjs/swagger/plugin"]
  }
}

Revision for PartialType

If we declare a DTO that utilizes the PartialType function for extending the attributes of a parent DTO, we need to implement the definition provided by the @nestjs/swagger module. Otherwise, the documentation will not render the correct properties of the DTO.

import { PartialType } from '@nestjs/swagger';
import { ParentDto } from './parent.dto';

export class ChildDto extends PartialType(ParentDto) {}

Add details of DTO properties

We can utilize the @ApiProperty() decorator on each property in a DTO to set details of the property.

import { ApiProperty } from '@nestjs/swagger';

export class SampleDto {
  @ApiProperty({ description: 'Name of the product' })
  @IsString()
  readonly name: string;

  @ApiProperty({ example: [] })
  @IsString({ each: true })
  readonly models: string[];
}

Add details of HTTP responses

By default, the documentation generated by the Swagger module will only show details of success responses based on the evaluated controllers. If we want to provide custom details or additional response definitions, we can utilize some decorators provided by the @nesjs/swagger module such as @ApiResponse(), @ApiForbiddenResponse(), and so on. These decorators can be applied both on a controller method and the class to provide default definitions for its contained methods.

@ApiResponse({ status: 404, description: 'Resource is not found' })
@Controller('product')
export class ProductController {

  @ApiResponse({ status: 401, description: 'Invalid query parameters' })
  @Get()
  findAll() {}

  @ApiForbiddenResponse({ description: 'Unauthorized access' })
  @Post()
  create() {}
}

Grouping the endpoints

To improve the readability of our documentation, sometimes we need to group or categorize our endpoints. We can apply the @ApiTags() decorator on our controller class.

@ApiTags('inventory')
@Controller('product')
export class ProductController {}

// ...
@ApiTags('inventory')
@Controller('product-category')
export class ProductCategoryController {}


Comments

  1. Keeping the privacy of your export and import data are very much important now a days. We are offering you a service that will maintain the privacy of your data and your competitors won't be able to analyze your data. To know more please contact Hide Import

    ReplyDelete

Post a Comment

Popular posts from this blog

Setting Up Next.js Project With ESLint, Typescript, and AirBnB Configuration

If we initiate a Next.js project using the  create-next-app tool, our project will be included with ESLint configuration that we can apply using yarn run lint . By default, the tool installs eslint-config-next and extends next/core-web-vitals in the ESLint configuration. The Next.js configuration has been integrated with linting rules for React and several other libraries and tools. yarn create next-app --typescript For additional configuration such as AirBnB, it is also possible. First, we need to install the peer dependencies of eslint-config-airbnb . We also add support for Typescript using eslint-config-airbnb-typescript . yarn add --dev eslint-config-airbnb eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks yarn add --dev eslint-config-airbnb-typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser After that, we can update the .eslintrc.json file for the new configuration. { "extends": [ "airb

Rangkaian Sensor Infrared dengan Photo Dioda

Keunggulan photodioda dibandingkan LDR adalah photodioda lebih tidak rentan terhadap noise karena hanya menerima sinar infrared, sedangkan LDR menerima seluruh cahaya yang ada termasuk infrared. Rangkaian yang akan kita gunakan adalah seperti gambar di bawah ini. Pada saat intensitas Infrared yang diterima Photodiode besar maka tahanan Photodiode menjadi kecil, sedangkan jika intensitas Infrared yang diterima Photodiode kecil maka tahanan yang dimiliki photodiode besar. Jika  tahanan photodiode kecil  maka tegangan  V- akan kecil . Misal tahanan photodiode mengecil menjadi 10kOhm. Maka dengan teorema pembagi tegangan: V- = Rrx/(Rrx + R2) x Vcc V- = 10 / (10+10) x Vcc V- = (1/2) x 5 Volt V- = 2.5 Volt Sedangkan jika  tahanan photodiode besar  maka tegangan  V- akan besar  (mendekati nilai Vcc). Misal tahanan photodiode menjadi 150kOhm. Maka dengan teorema pembagi tegangan: V- = Rrx/(Rrx + R2) x Vcc V- = 150 / (150+10) x Vcc V- = (150/160) x 5

Itachi Uchiha

The Real Hero of Konoha

How To Use Git in Netbeans

Git is a popular version control application nowadays. Recently I have created a note about its differences with SVN and how to use it in Eclipse . There are many Git client tools. But I just want to show how to use Netbeans built-in Git tools. It makes the development process easier because it has been integrated with the IDE. Create Remote Git Repository We need a remote Git repository so everyone can store or receive any revision or updated files through the networks. We can set up our own Git server or use a public Git server like Github . In this note, I use Github. 1. Create an account in Github and create an empty Git repository Create an empty public repository in Github 2. Get the remote repository link Your Github Repository URL Create a New Project in Netbeans and Create Local Git Repository After we have a remote Git repository, we can create a project stored in the remote repository. We also need to create a local repository before we can push

Raspberry Pi Bluetooth Connection

Raspberry Pi 3 provides a built-in Bluetooth module. The latest Raspbian has been bundled with tools for enabling Bluetooth connection. The Bluetooth icon will be shown up on the top right corner of the desktop. It's a tool to discover available Bluetooth devices and connect Pi with Bluetooth devices. It is easy to connect any Bluetooth-enabled electronic device with Pi. But, sometimes Pi will fail to connect, especially for Bluetooth device that has no standardized services. From a terminal, we can use the  bluetoothctl tool to scan and connect with a Bluetooth device. You should make sure that the BlueZ protocol stack has been installed by running $ apt-get install bluez Run bluetoothctl to enter the tool command window Turn the power on by running power on (Optional) You can set AutoEnable=true in /etc/bluetooth/main.conf if you want to make the Bluetooth auto power-on after reboot. Run devices to see which devices have been paired Run scan on if your desired d

Configuring Swap Memory on Ubuntu Using Ansible

If we maintain a Linux machine with a low memory capacity while we are required to run an application with high memory consumption, enabling swap memory is an option. Ansible can be utilized as a helper tool to automate the creation of swap memory. A swap file can be allocated in the available storage of the machine. The swap file then can be assigned as a swap memory. Firstly, we should prepare the inventory file. The following snippet is an example, you must provide your own configuration. [server] 192.168.1.2 [server:vars] ansible_user=root ansible_ssh_private_key_file=~/.ssh/id_rsa Secondly, we need to prepare the task file that contains not only the tasks but also some variables and connection information. For instance, we set /swapfile  as the name of our swap file. We also set the swap memory size to 2GB and the swappiness level to 60. - hosts: server become: true vars: swap_vars: size: 2G swappiness: 60 For simplicity, we only check the exi