[미소 클론코딩 프로젝트] 2-10. 관리자 서비스 API 설계 - 이용자 및 회원정보 관리

2023.08.12 - [초기 과업/BackEnd] - [미소 클론코딩 프로젝트] 2-9. 관리자 서비스 API 설계 - 관리자 인증/인가

[미소 클론코딩 프로젝트] 2-9. 관리자 서비스 API 설계 - 관리자 인증/인가

 

안녕하세요. 기깔나는 사람들에서 백엔드를 맡고있는 황시아입니다.

지난 시간에 관리자 인증/인가 API를 설계했던 것에 이어서 이용자 및 회원정보 관리 API를 설계해 보겠습니다.

 

---

이용자 및 회원정보 관리 API

 

---

회원정보 조회

Request

API 호출 방식

요청 URL	메서드
/api/administrators/members	GET

 

Request Header

Request Header에 대한 상세는 다음과 같습니다.

파라미터	타입	필수 여부	설명
Authorization	String	필수	Bearer {JWT_TOKEN} - {JWT_TOKEN} : 로그인 JWT 토큰
Content-Type	String	필수	application/json이어야 함

 

Request Syntax

curl -X GET http://{BASE_URL}/api/administrators/members \
    -H "Content-Type: application/json;charset=utf-8" \
    -H "Authorization: Bearer {JWT_TOKEN}"

 

Response

Response Elements

Response Elements에 대한 상세는 다음과 같습니다.

필드	상위 필드	타입	필수 여부	설명
statusCode		Integer	필수	API 공통 가이드 - 공통 Response 참조
message		String	필수	API 공통 가이드 - 공통 Response 참조
data		Object	필수	회원정보 목록
id	data	Integer	직원 이상 공개	회원 고유번호
name	data	String	직원 이상 공개	회원명
email	data	String	직원 이상 공개	이메일
address	data	String	팀장 이상 공개	주소
contact	data	String	팀장 이상 공개	연락처
location	data	Strgin	직원 이상 공개	접속위치
ip	data	String	슈퍼관리자 이상 공개	IP

 

Response Syntax

{
  "statusCode": 200,
  "message": "성공",
  "data": {
      "id": 1,
      "name": "회원명1",
      "email": "이메일",
      "address": "주소",
      "contact": "연락처",
      "location": "접속위치",
      "ip": "XXX.XXX.XXX.XXX"
  }
}

---

회원 이용불가 처리

Request

API 호출 방식

요청 URL	메서드
/api/administrators/members/{id}/block	PATCH

 

Request Header

Request Header에 대한 상세는 다음과 같습니다.

파라미터	타입	필수 여부	설명
Authorization	String	필수	Bearer {JWT_TOKEN} - {JWT_TOKEN} : 로그인 JWT 토큰
Content-Type	String	필수	application/json이어야 함

 

Request Elements

없음

 

Request Syntax

curl -X PATCH http://{BASE_URL}/api/administrators/members/{id}/block \
    -H "Content-Type: application/json;charset=utf-8" \
    -H "Authorization: Bearer {JWT_TOKEN}"

 

Response

Response Elements

Response Elements에 대한 상세는 다음과 같습니다.

필드	상위 필드	타입	필수 여부	설명
statusCode		Integer	필수	API 공통 가이드 - 공통 Response 참조
message		String	필수	API 공통 가이드 - 공통 Response 참조

 

Response Syntax

{
  "statusCode": 200,
  "message": "성공"
}