[백엔드] API 명세서 작성법

API 명세서를 작성하는 이유

• API명세서를 작성하지 않으면 사용자는 어떤 정보를 어떤 방식으로 요청해야하는지, 어떤 정보를 전달받을 수 있을지, 어떤 형식으로 데이터가 넘어오는지 알 수 없다.

API 명세서 작성법

sample

Method, URI, Request body, Response body, Description 속성은 되도록이면 포함되어야 한다.

• Method: HTTP Method을 의미한다. (GET, POST, PUT, DELETE 등)
• URI: 인터넷의 자원을 식별할 수 있는 문자열 또는 주소
• Request Body: API에 제공할 데이터 (요청할 데이터 )
  • 주로 POST, PUT일 때 함께 작성됨
• Response Body: API가 생성하는 응답 데이터
  - 일반적으로 JSON 및 XML 형식
• Description: 상세 설명

➕

Status: API 응답에서 반환되는 상태 코드와 설명 (예: 200 - OK, 400 - Bad Request 등).
params: Query params, Path params 등
Headers: Content-Type, Authorization 등