To-do API specification 설계하기 #6
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
OpenAPI 명세서에 Task를 생성, 조회, 수정, 삭제하는 API를 추가하였습니다.
주요 변경사항:
1. Task 생성을 위한 POST /tasks API 추가: Task의 내용을 입력받아 새로운 Task를 생성합니다.
2. Task 조회를 위한 GET /tasks/{taskId} API 추가: 특정 Task의 정보를 조회합니다.
3. Task 수정을 위한 PATCH /tasks/{taskId} API 추가: 특정 Task의 내용을 수정합니다.
4. Task 삭제를 위한 DELETE /tasks/{taskId} API 추가: 특정 Task를 삭제합니다.
5. 각 API의 요청과 응답에 대한 명세를 추가하였습니다.
Member
|
PR 본문에 어떤 점을 개선했는지, 왜 그렇게 했는지 적어주면 API 스펙을 가지고 논의할 수 있습니다. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
개선 사항
1. 할 일 (
Task) 관리 API 구현Task)의 목록 조회, 등록, 수정, 삭제 기능을 작성했으며, 엔드포인트는 다음과 같습니다.GET /tasks: 모든 할 일(Task) 목록을 조회POST /tasks: 할 일을 등록GET /tasks/{taskId}: 특정 Task ID로 할 일 조회PATCH /tasks/{taskId}: 할 일 내용 수정DELETE /tasks/{taskId}: 할 일 삭제2. 상태 확인 API 추가
/를 추가했습니다. 서버가 정상 작동하는지 확인하는 용도로 사용되며, 정상일 경우 200 응답을 반환합니다.3. 입출력에 대한 유효성 검사
POST /tasks에contents에 문자열 외 타입에 대해 400 에러 메세지를 반환합니다.개선 이유