API 명세서와 구현

📖 목차

1. API 명세서
   - API 리스트업
   - API 명세서
   
   
2. API 구현
   
   

📌 API 명세서

1) API 리스트업

주요 기능에 따라 도메인 나누고 리스트업
예) 당근마켓

• 상품 (/products)
• 회원 (/users)
• 동네 (/regions)
• 관심 (/wishlists)
• 후기 (/feedbacks)
  

예) 번개장터

• 상품(/products)
• 회원(/users)
• 카테고리(/categories)
• 채팅(/chats)
• 계좌(/accounts)
• 구매(/purchases)
  

2) API 명세서

각 리스트업한 API마다 명세서를 작성하는 단계

명세서에는 아래 항목에 대한 설명이 포함되어야 함

• HTTP Method
• URL
• HEADER(메타 데이터)
• BODY(요청 데이터)
• Query String
• Path Variable
• Response Paramters (Response Sample)
• Result Code

예) 번개장터 API 명세서 일부 [API 명세서 더 자세히 보기 내 깃허브]

=> 협업 프로젝트 과정에서 느낀바로는
프론트엔드 개발자가 API 명세서를 보고 서버와 통신하므로
프론트에서 봤을 때 잘 이해하고 사용할 수 있도록 작성하는 것이 중요함

&링크모음
API 명세서 자세히 보기, 나의 깃허브, README 파일