-
Notifications
You must be signed in to change notification settings - Fork 2
Open
Description
⛳ 목적
1. 필요한 응답 헤더만 남겨 필요한 내용만 API 설계 문서에 담기도록 수정한다.
API 명세는 설계 문서이므로, 응답 헤더에 추가 정의한 필드가 없다면 명세에 작성하지 않는 것이 좋습니다.
2. Path parameters 스닙펫 추가 정의를 통해 API 명세 이해도를 높인다.
- API 명세의 path param 이 '변수명'이 아닌 '값'으로 작성되어 있어 명세를 이해하기 어려운 부분들이 있습니다.
- path를 명시하고, path parameters에 대한 충분한 설명을 할 수 있도록 커스텀 스닙펫을 추가하고자 합니다.
개발 내용
- 불필요한 응답 헤더는 제외하고 문서화하도록 RestDocs 설정 수정
- Path parameters 스닙펫 추가
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Type
Projects
Status
4주차