[nestjs/swagger] nestjs에서 간단하게 swagger를 활용한 document(문서) 자동화 [구현] 2/3

[nestjs/swagger] nestjs에서 간단하게 swagger를 활용한 document(문서) 자동화 [구현] 2/3

 

[Get 함수 구현에 API 문서 정보 등록하기]

@Controller('beacon')
@ApiTags('비콘 API')
export class BeaconController {
  constructor(private readonly service: BeaconService) {}

	@Get('/:id')
    @ApiOperation({
      summary: '목록 조회',
      description: '목록 조회',
    })
    getTestOne(@Param('id') id: number): Promise<tb_beacon> {
      return this.service.getOne(id);
    }
    
  }

@ApiTags - Controller 수준의 설명 추가

@ApiOperation - 함수 수준의 설명 추가

 

다음과 같이 출력된다.

기본적인 설명은 이정도만으로도 충분히 설명이된다.

 

#nestjs #swagger #swaggerUI #문서화 #문서자동화 #api #api 문서화 #api 문서 자동화 #swagger 문서 자동화

#@ApiTags #@ApiOperation