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

Kerusakan pada Motherboard

1. Sering terjadi hang memory tidak cocok --- ganti memory ada virus di harddisk --- scan harddisk over clock --- seting kembali clock prosesor ada bad sector di harddisk --- partisi harddisk dengan benar 2. Pembacaan data menjadi lambat memori tidak cukup --- tambah memori harddisk penuh atau ada virus --- kurangi isi harddisk, scan harddisk, atau ganti hardisk 3. CMOS failure baterai habis --- ganti baterai CMOS seting BIOS berubah --- seting kembali BIOS 4. Tidak bisa booting cache memory rusak --- disable eksternal cache memory di BIOS memori tidak cocok --- ganti memori boot sector pada harddisk rusak --- masukkan operating system baru ada bad sector pada trek awal harddisk --- partisi harddisk 5. Suara bip panjang berkali-kali memori rusak --- periksa kedudukan memori memori tidak cocok --- ganti memori memori tidak masuk slot dengan sempurna --- periksa kembali kedudukan memori 6. Suara bip bagus tetapi tidak ada tampilan / bip dua kali VGA card

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

Refund Tiket Kereta Api

Pada Desember 2013 saya telah berencana untuk pergi ke Kebumen dari Bandung menggunakan kereta api. Namun karena ada tugas yang mendesak maka saya membatalkan rencana tersebut. Tiket saya beli secara online. Pada waktu itu peraturan pembatalan pembelian tiket adalah 1 jam sebelum keberangkatan. Saya mengajukan pembatalan pada satu hari sebelum keberangkatan. Langkah-langkah pengajuan refund adalah seperti berikut. Jika Anda membeli tiket secara online, cetaklah tiket Anda terlebih dahulu di stasiun. Untuk stasiun Bandung lokasi pencetakan tiket di dekat loket Costumer Service. Pencetakan dilakukan sendiri (self service) menggunakan perangkat komputer yang disediakan dengan memasukkan kode booking pada aplikasi yang ada. Setelah itu Anda dapat bertanya pada petugas di mana loket untuk pengajuan refund. Untuk stasiun Bandung loket untuk pengajuan refund saat itu berada di loket terakhir yaitu loket 9.  Setelah menunjukkan tiket maka kita diminta mengisi formulir pengajuan pembatalan.

Itachi Uchiha

The Real Hero of Konoha

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

Pemrograman Paralel dengan CUDA

CUDA ( Compute Unified Device Architecture ) adalah suatu skema yang dibuat oleh NVIDIA agar NVIDIA selaku GPU ( Graphic Processing Unit ) mampu melakukan komputasi tidak hanya untuk pengolahan grafis namun juga untuk tujuan umum. Jadi, dengan CUDA, kita dapat memanfaatkan cukup banyak  processor  yang dimiliki oleh NVIDIA untuk berbagai perhitungan. GPU yang ada  saat ini seperti ATI pun sudah memiliki banyak processor di dalamnya. Pada ATI, skema yang mereka bangun disebut ATI Stream. Saat ini pemrograman paralel menjadi sangat penting karena kebutuhan kemampuan komputasi komputer yang terus meningkat seperti kemampuan multitasking  dan pengolahan grafis yang andal. Metode saat ini dalam peningkatan peforma komputer juga berbeda dengan masa lampau dimana peningkatan clock  dari processor  yang diutamakan. Peningkatan clock  juga dibatasi oleh kemampuan fisik dari perangkat digital yaitu persoalan daya dan panas. Pada 2005 berbagai industri komputer mulai menawakan komputer den