[미소] 클론코딩 프로젝트 2-2) 이용자 서비스 API 설계 - 회원가입

 

2023.08.10 - [초기 과업/BackEnd] - [미소] 클론코딩 프로젝트 2-1) API 공통 가이드

[미소] 클론코딩 프로젝트 2-1) API 공통 가이드

 

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

 

저번 시간에 API 공통 가이드 설계를 진행했습니다.

이제 이용자 서비스 API 설계를 진행할 것입니다.

이번 포스트에서는 이용자 서비스 중 회원가입 서비스를 제공할 API를 설계합니다.

 

 

회원가입 API

 

API 호출 방식

요청 URL	메서드
/api/members/auth/signup	POST

 

Request

Request Header

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

파라미터	타입	필수여부	설명
Content-Type	String	필수	application/json이어야 함

 

Request Elements

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

필드	상위 필드	타입	필수 여부	설명
name		String	필수	이름
email		String	필수	이메일
password		String	필수	비밀번호
contact		String	필수	연락처
essentialUse		Boolean	필수	서비스 이용약관 필수동의
essentialPersonal		Boolean	필수	개인정보 이용약관 필수동의
selectiveMarketing		Boolean	필수	마케팅 개인정보 이용동의 선택약관

 

Request Syntax

curl -X POST http://{BASE_URL}/api/members/auth/signup \
     -H "Content-Type: application/json;charset=utf-8" \
     -d \
        '{\
                "name": "이름",\
                "email": "이메일",\
                "password": "비밀번호",\
                "essentialUse": "서비스이용 필수약관",\
                "essentialPersonal": "개인정보 필수약관",\
                "marketingConsent": "마케팅 선택약관"\
         }'

 

 

Response

Response Elements

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

필드	상위 필드	타입	필수 여부	설명
statusCode		Integer	필수	API 공통 가이드 - 공통 Response 참조 - 200 : data 필드, pagenation 필드와 함께 반환 - else : data 필드, pagenation 필드 없이 반환
message		String	필수	API 공통 가이드 - 공통 Response 참조
data		Object	선택	회원정보
sequence	data	Integer	필수	생성된 회원 고유번호

 

Response Syntax

{
    "statusCode": 200,
    "message": "성공",
    "data": {
        "sequence": 1
    }
}