[Semi-Project] API 명세서 작성 및 ERD 수정 (3)

오늘은 프로젝트 개발 전, 프론트와 백 개발자가 나뉘어져 개발 할 때 반드시 필요한 API. 명세서를 작성하였고, 이를 통해 request 와 response 에 대하여 더 자세하게 공부할 수 있었습니다. 비록, 백엔드와 프론트엔드를 따로 나누어 개발하지 않지만 현업에서 사용되는 방식을 한번 사용해보고자에 대한 목적을 가지고 작성하게 되었습니다.

 

API 명세서란 ?

API 명세서는 개발자들이 서로 다른 시스템 간의 상호작용을 위한 인터페이스를 정의하고 문서화하는 데 사용하는 문서 입니다. 쉽게 표현하여 프론트와 백엔드가 서로 동시에 개발을 하며, 주고받을 데이터에 관하여 미리 명시해 놓고 개발하는 것입니다. 

 

API 명세서는 개발전 작성과 개발후 작성으로 크게 두가지로 나뉘어 생각할 수 있습니다.

개발전 작성하는 API 명세서는 요청 및 응답구조, 데이터 형식 등을 사전에 계획하는 것이며, front, backend, UI/UX 등 여러 팀 간의 커뮤니케이션을 원할하게 해줍니다. 또한 명세서를 통해 설계를 검토할 수 있으며 문서화 되어 개발시 중요한 참조 자료로 활용 됩니다. 대게, 엔드포인트 URL, 요청 메서드 (GET, POST, PUT, DELETE 등), 요청 및 응답 형식, 전달한 데이터와 데이터의 타입, 에러코드 및 예외처리 방법 등에 관하여 작성하게 됩니다.

 

개발후 작성하는 API 명세서는 실제 구현된 API 를 반영합니다. 또한 개발 중 변경된 사항이나 추가된 기능을 업데이트 합니다. 따라서 API 를 사용하고자 하는 개발자들에게 필요한 기술적 정보를 제공하는데 중점을 둡니다. 대게, 실제 요청 및 응답 예시, 세부 파라미터 설명 및 데이터 모델, 사용 가능한 HTTP 헤더 및 필요한 인증 방법, 성공 및 오류 응답코드에 대한 설명 등에 관하여 작성하게 됩니다.

 

이번 우리조는 개발전 API 명세서를 POSTMAN 을 활용하여 작성하였고, 처음 작성해보는 명세서라 정확한 틀과 규칙을 정하지 못한채 작성하게 되었습니다. (작성해봤다는 것에 의의를 두고 ..);;

POSTMAN

https://documenter.getpostman.com/view/34814297/2sA3XPCNLY

 

ERD

수정된 ERD 는 아래의 이미지와 같다.. !