<div id="readability-page-1" class="page"><div role="banner"> <div> <h4>22 Mar 2023</h4> Reading time ~1 minute 
 </div> <h2 id="package-lockjson에서-nexus-repository-변경시-처리-방법">package-lock.json에서 Nexus Repository 변경시 처리 방법</h2> 페이징 처리시 다음의 DTO를 사용하고 있습니다. <div><pre><code>export class Pagination&lt;T&gt; {
 @ApiProperty()
 public results: T[];
 @ApiProperty()
 public page_total: number;
 @ApiProperty()
 public total: number;

 constructor(paginationResults: PaginationResultInterface&lt;T&gt;) {
 this.results = paginationResults.results;
 this.page_total = paginationResults.results.length;
 this.total = paginationResults.total;
 }
}
</code></pre></div> 다른 부분의 표현은 문제가 없는데, <code>generic</code> 타입인 <code>public results: T[];</code>를 제대로 표현하지 못해서 아쉬움을 느끼고 있었습니다. <a href="https://aalonso.dev/blog/how-to-generate-generics-dtos-with-nestjsswagger-422g">How to generate Generics DTOs with nestjs/swagger</a>를 찾아서 적용하니 잘 표현 되네요. 적용 방법은 아래와 같습니다. 우선 신규 <code>ApiOkResponsePaginated</code> 데코레이터를 추가 합니다. <div><pre><code>import {
 ApiOkResponse,
 getSchemaPath,
 ApiExtraModels,
 ApiProperty,
} from '@nestjs/swagger';
import { PaginationResultInterface } from './pagination.results.interface';
import { applyDecorators, Type } from '@nestjs/common';

export class Pagination&lt;T&gt; {
 // 중요! ApiProperty 를 사용하지 않음
 public results: T[];
 @ApiProperty()
 public page_total: number;
 @ApiProperty()
 public total: number;

 constructor(paginationResults: PaginationResultInterface&lt;T&gt;) {
 this.results = paginationResults.results;
 this.page_total = paginationResults.results.length;
 this.total = paginationResults.total;
 }
}

// 데코레이터 추가
export const ApiOkResponsePaginated = &lt;DataDto extends Type&lt;unknown&gt;&gt;(
 dataDto: DataDto
) =&gt;
 applyDecorators(
 ApiExtraModels(Pagination, dataDto),
 ApiOkResponse({
 schema: {
 allOf: [
 { $ref: getSchemaPath(Pagination) },
 {
 properties: {
 data: {
 type: 'array',
 items: { $ref: getSchemaPath(dataDto) },
 },
 },
 },
 ],
 },
 })
 );
</code></pre></div> 마지막으로 아래와 같이 사용하려는 컨트롤러에서 <code>@ApiResponse</code> 대신 <code>@ApiOkResponsePaginated</code> 를 사용합니다. <div><pre><code> @ApiOperation({ summary: '아이템 상품 목록 조회' })
 @ApiOkResponsePaginated(ItmPrdMRO) // ApiOkResponsePaginated와 함께 사용할 generic 타입 지정
 @Get('prd/list')
 async getItmPrdMPaginate(@Query() dto: FindByCondDto) {
 return await this.itmPrdMService.getItmPrdMPaginate(dto);
 }
</code></pre></div> 설정을 하고 결과를 확인하면 아래와 같이 원하는 response schema를 확인 할 수 있습니다. <div><pre><code>{
 "page_total": 0,
 "total": 0,
 "data": [
 {
 "id": 0,
 "admAdminMIdNm": "string",
 "itmDcd": "string",
 "imgPath": "string",
 "itmWearDcdNm": "string",
 "avlbStrtDt": "string",
 "avlbEndDt": "string",
 "appItmNm": "string",
 "itmNm": "string",
 "prdAmt": 0,
 "modDtm": "string"
 }
 ]
}
</code></pre></div> <h2 id="참고자료">참고자료</h2> <ul> <li><a href="https://aalonso.dev/blog/how-to-generate-generics-dtos-with-nestjsswagger-422g">How to generate Generics DTOs with nestjs/swagger</a></li> </ul> </div></div>

lahuman

Daniel Lim

package-lock.json에서 Nexus Repository 변경시 처리 방법
페이징 처리시 다음의 DTO를 사용하고 있습니다.
export class Pagination<T> {
 @ApiProperty()
 public results: T[];
 @ApiProperty()
 public page_total: number;
 @ApiProperty()
 public total: number;
 constructor(paginationResults: PaginationResultInterface<T>) {
 this.results = paginationResults.results;
 this.page_total = paginationResults.results.length;
 this.total = paginationResults.total;
 }
}
다른 부분의 표현은 문제가 없는데, generic 타입인 public results: T[];를 제대로 표현하지 못해서 아쉬움을 느끼고 있었습니다.
How to generate Generics DTOs with nestjs/swagger를 찾아서 적용하니 잘 표현 되네요.
적용 방법은 아래와 같습니다.
우선 신규 ApiOkResponsePaginated 데코레이터를 추가 합니다.
import {
 ApiOkResponse,
 getSchemaPath,
 ApiExtraModels,
 ApiProperty,
} from '@nestjs/swagger';
import { PaginationResultInterface } from './pagination.results.interface';
import { applyDecorators, Type } from '@nestjs/common';
export class Pagination<T> {
 // 중요! ApiProperty 를 사용하지 않음
 public results: T[];
 @ApiProperty()
 public page_total: number;
 @ApiProperty()
 public total: number;
 constructor(paginationResults: PaginationResultInterface<T>) {
 this.results = paginationResults.results;
 this.page_total = paginationResults.results.length;
 this.total = paginationResults.total;
 }
}
// 데코레이터 추가
export const ApiOkResponsePaginated = <DataDto extends Type<unknown>>(
 dataDto: DataDto
) =>
 applyDecorators(
 ApiExtraModels(Pagination, dataDto),
 ApiOkResponse({
 schema: {
 allOf: [
 { $ref: getSchemaPath(Pagination) },
 {
 properties: {
 data: {
 type: 'array',
 items: { $ref: getSchemaPath(dataDto) },
 },
 },
 },
 ],
 },
 })
 );
마지막으로 아래와 같이 사용하려는 컨트롤러에서 @ApiResponse 대신 @ApiOkResponsePaginated 를 사용합니다.
 @ApiOperation({ summary: '아이템 상품 목록 조회' })
 @ApiOkResponsePaginated(ItmPrdMRO) // ApiOkResponsePaginated와 함께 사용할 generic 타입 지정
 @Get('prd/list')
 async getItmPrdMPaginate(@Query() dto: FindByCondDto) {
 return await this.itmPrdMService.getItmPrdMPaginate(dto);
 }
설정을 하고 결과를 확인하면 아래와 같이 원하는 response schema를 확인 할 수 있습니다.
{
 "page_total": 0,
 "total": 0,
 "data": [
 {
 "id": 0,
 "admAdminMIdNm": "string",
 "itmDcd": "string",
 "imgPath": "string",
 "itmWearDcdNm": "string",
 "avlbStrtDt": "string",
 "avlbEndDt": "string",
 "appItmNm": "string",
 "itmNm": "string",
 "prdAmt": 0,
 "modDtm": "string"
 }
 ]
}
참고자료
How to generate Generics DTOs with nestjs/swagger

nestjs에서 swagger사용시, generic 타입에 대한 response schema 처리

댓글