![]()
프로젝트 진행 중 작성한 wiki 를 옮겨와 편집했습니다. 팀원들 고생하지 말라고 필수적인 태그만 정리한 거라 부족한 점이 많습니다. Nest 와 Swagger 공식문서를 보면서 태그 쇼핑하시는 것을 추천합니다. 하지만 제가 프로젝트 시작할 때는 다른 사람들이 대체 무슨 태그를 쓰는 지 궁금했어서 기록용으로 남깁니다...ㅎㅎ ApiOperation Api에 대한 설명을 적는 태그입니다. 사용 예 @ApiOperation({ summary: '친구 신청하기 (닉네임)' }) 적용 스크린샷 Path 옆에 summary 의 내용이 나타납니다. 메소드 위에 주석 (/**/) 을 쓰면 더 상세한 표기가 가능합니다. (Nest 의 swagger plugin 을 적용했을 경우) Api{StatusCode}Respon..
![]()
프로젝트 진행 중 작성한 wiki 를 옮겨와 편집했습니다. swagger OpenAPI Speciation (OAS) 를 활용할 수 있는 도구. OpenAPI 란 RESTful 인터페이스를 정의하기 위한 세계 표준이다. OAS 로 technology-agnostic API 를 설하고 개발, 사용할 수 있다. Use in nest! yarn add @nestjs/swagger nest 는 OpenAPI 를 데코레이터로 만들 수 있는 모듈을 제공한다. DocumentBuilder 로 OpenAPI 사양을 준수하는 기본 문서를 구축할 수 있다. 전체문서 (all HTTP routes defined) 를 생성하려면 SwaggerModule 의 createDocument() 를 사용한다. 순서대로 applicat..
