프로젝트 DB & API 설계
DB & API 설계를 하기 전, 수업 시간에 보연 멘토님께서 DB / API / Restful API 기본 개념을 설명해주셨다. 이해하기 쉽게 설명을 해주셔서 함께 수업자료를 보면서 따라가긴 했는데, Restful API와 URI 설계시 주의할 점은 다시 제대로 공부해야겠다.
DB & API 설계는 백엔드 미영님께서 먼저 설계해주신 명세서를 바탕으로 수정할 부분에 대해 회의를 진행했다. 미영님 덕분에 정리된 API 명세서를 확인하니 이해하는데 도움이 많이 되었다. 또 진행하는 프로젝트를 예시로 하여 미영님께서 차근차근 설명을 잘해주셔서 DB / API / Request / Response에 대해서도 쉽게 이해할 수 있었다. 감사합니다! 🙏
DB & API 명세서를 제출하는 날까지도 API 명세서로 혼란을 겪기도 했었는데, 팀원 모두 합심하여 API 명세서를 기능별로 재분류하고 마지막으로 미영님께서 정리해주셨다. DB & API 설계를 하며 다시 한번 프론트엔드와 백엔드의 의사소통의 중요성을 크게 느꼈다. 그리고 아직 ERD 명세서는 이해하기 어려웠다. 차근차근 공부해보자!
API 명세서
HTTP Method
GET: 조회
POST: 등록
PUT: 전체 수정
PATCH: 리소스의 일부분을 수정
DELETE: 삭제
URI 설계 시 주의할 점
1) 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용
2) URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
3) 하이픈(-)은 URI 가독성을 높이는데 사용
4) 밑줄(_)은 URI에 사용하지 않는다.
5) URI 경로에는 소문자가 적합하다.
6) 파일 확장자는 URI에 포함시키지 않는다.
Reference | 카우치코딩: 개발 초보를 위한 RESTful API 설계 가이드
