728x90
nestjs
-
NestJS Swaager 사용시 직관적이고 구체적인 응답 문서화 하기백엔드/견고한 백엔드 만들기 2024. 7. 9. 15:17
Swagger 문서는 프론트엔드 개발자와 소통을 위해 중요한 api 문서화 역할을 한다. 현재 Response 문서에는 상태 코드와 설명뿐이다 응답 성공시 기존 피드 생성 성공시 response swagger 예를들어 피드 생성에 성공에 대한 response인데 해당 피드가 공개 피드 생성 했을때 response와 비공개 피드 생성시 response를 보다 구체적으로 swagger로 제공 해준다면 프론트 엔드 개발자 입장에서 swagger 문서에 대한 가독성이 굉장히 올라갈것이다. 응답 실패시 기존 피드 삭제 에러 response swagger 404 에러 코드에 해당하는 에러 경우가 2가지인데 1. 2. 이런식으로 메세지만 구별되어 있어 구체적이지 못하고 가독성이 떨어진다. 끝으로 보다 직관적이..