API Specification

✔️ API Specification

Common Status Code

Status Code	Description
200 OK	성공
201 CREATED	생성
304 MOVED PERMENANTLY	영구적인 리다이렉션
400 BAD REQUEST	잘못된 요청
401 UNAUTHORIZED	비인증 상태
403 FORBIDDEN	인가 오류(허용되지 않은 자원에 접근 등)
404 NOT FOUND	리소스가 존재하지 않음
409 CONFLICT	리소스 충돌(자원 중복 등)
415 UNSUPPORTED MEDIA TYPE	컨텐츠 타입이 부적절함
500 INTERNAL SERVER ERROR	서버 내부 오류

Response Fields

Location	Name	Type	Description	Required
Body	code	String	오류 코드	true
Body	message	String	오류 메시지	true
Body	detail	String	오류 세부사항	true

[POST] {protocol}://{domain}:{port}/users/sign-up

Description

사용자 회원가입

Request Fields

Location	Name	Type	Description	Required
Body	identifier	String	아이디(이메일)	true
Body	password	String	비밀번호	true
Body	nickname	String	닉네임	false

Response Fields

Location	Name	Type	Description	Required
Body	code	String	결과 코드	true
Body	message	String	결과 메시지	true
Body	data	JSON	데이터	false

[POST] {protocol}://{domain}:{port}/users/sign-in

Description

사용자 로그인

Request Fields

Location	Name	Type	Description	Required
Body	identifier	String	아이디(이메일)	true
Body	password	String	비밀번호	true

Response Fields

Location	Name	Type	Description	Required
Header	Authorization	String	JWT Access Token	true
Cookie	Authorization	String	JWT Refresh Token	true
Body	code	String	결과 코드	true
Body	message	String	결과 메시지	true
Body	data	JSON	데이터	false

[GET] {protocol}://{domain}:{port}/users/sign-out

Description

사용자 로그아웃

Request Fields

Location	Name	Type	Description	Required
Header	Authorization	String	JWT Access Token	true
Cookie	Authorization	String	JWT Refresh Token	true

Response Fields

Location	Name	Type	Description	Required
Body	code	String	결과 코드	true
Body	message	String	결과 메시지	true
Body	data	JSON	데이터	false