회원 관리 앱의 기능 명세서를 바탕으로, 앱에서 사용할 API 엔드포인트의 명세서를 작성하는 과제예요.
각 API가 수행해야 하는 기능과 입력/출력 데이터 구조를 명확히 정의하세요.
-
필수 요구 사항
- 1주차 기능 명세서의 회원 목록 조회, 회원 상세 조회, 회원 생성, 회원 수정, 회원 삭제 기능을 위한 API 명세서를 설계하세요.
- 각 기능을 위한 HTTP 메서드(GET, POST, PUT, DELETE 등)와 엔드포인트를 지정하세요.
- 각 API 엔드포인트의 요청 및 응답 예시(JSON 형식)를 작성하세요.
-
요청(Request) 명세
- 각 엔드포인트의 요청에서 필요한 파라미터와 데이터 형식을 정의하세요.
- 예를 들어, 회원 생성 요청에서는
이름,이메일,전화번호,가입일자가 포함된 JSON 요청 본문(body)이 필요할 수 있습니다.
-
응답(Response) 명세
- 각 엔드포인트가 반환할 응답의 데이터 형식과 구조를 정의하세요.
- 예를 들어, 회원 목록 조회 API는 회원들의 리스트를 포함한 JSON 배열을 반환하고, 회원 상세 조회 API는 개별 회원의 상세 정보를 포함하는 JSON 객체를 반환합니다.
- 성공 응답과 오류 응답에 대해 각각 정의하고, HTTP 상태 코드(예: 200, 404, 400, 201 등)를 명시하세요.
-
오류 처리
- 각 API에서 예상할 수 있는 주요 오류 상황(예: 존재하지 않는 회원을 조회하려는 경우, 필수 입력 데이터가 누락된 경우 등)에 대한 오류 메시지와 상태 코드를 정의하세요.
- 오류 응답에는 상태 코드와 함께 적절한 오류 메시지를 포함하세요.
- RESTful API 설계 원칙을 참고하여, 일관성 있는 URL 및 메서드를 정의하세요.