[1차 프로젝트 록차] API 명세서 작성해보기

1차 스프린트 이후 문서화의 중요성을 체감하고

노션으로 API 명세서를 만들어보았다. (완성된 API 명세서 < 클릭!)

 

장고 앱(Users, Categories, Products, Cart, Order) 기준으로 큰 제목을 쓰고,

각 앱에서 만든 api를 제목 밑에 적어주었다.

 

각 항목을 클릭하면 더 자세한 내용을 볼 수 있다.

엔드포인트와 요청 형식, 응답 형식을 적어두고

설명만으로 부족한 항목은 예시도 적어주었다.

 

예를 들면 상품 상세 api를 클릭하면 다음과 같은 내용을 확인할 수 있다. 

 

처음부터 백엔드는 api를 만들면서 명세서를 작성하고 프론트는 api 명세서를 보며 작업하면 좋았겠지만

지금부터라도 명세서를 잘 활용해봐야겠다.