API 명세

기본 보기

우선순위

담당

완료여부

분류

기능

method

url

궁금한 점

요구사항

request header

request

response

에러코드

필수

민중

완료

로그인

Open

POST

/api/auth/login

사용자가 로그인을 하면 Jwt 를 발급받는다.

{ "username": "로그인아이디", (String) "password": "비밀번호", (String) }

204 OK 헤더: Jwt 엑세스 토큰, 쿠키: Refresh 토큰

필수

민중

완료

로그아웃

Open

DELETE

/api/auth/logout

브라우저에서 서버로 토큰을 보낸 후 토큰 삭제

Authorization - Jwt

204 NO_CONTENT

추가

민중

완료

토큰 재발급

Open

POST

/api/auth/reissue

Refresh 토큰으로 요청하여 Refresh, Access 토큰 재발급

쿠키: Refresh 토큰

204 OK 헤더: Jwt 엑세스 토큰, 쿠키: Refresh 토큰

400 유효하지 않은 토큰으로 요청시

비밀번호 검증

Open

POST

에러응답 포맷으로 작성

추가

보류

소셜 로그인

Open

GET

제외

보류

이메일 인증 (이메일 가입 시)

Open

GET

/api/auth/email/verify

필수

민중

완료

회원 및 인증

회원가입

Open

POST

/api/member/signup

새로운 사용자가 ID와 비밀번호의 형태로 서비스에 가입할 수 있어야 합니다.

{ "username": "로그인아이디", (String) "password": "비밀번호", (String) "nickname": "닉네임" }

201 CREATED

필수

민중

완료

아이디 중복검사

Open

GET

/api/member/username/verify?username={username}

아이디 중복검사

query string username - 아이디

204 NO_CONTENT

409 - 아이디가 존재하는 경우

필수

민중

완료

프로필 관리

닉네임 중복검사

Open

GET

/api/member/nickname/verify

200 OK

409 - 닉네임이 존재하는 경우

추가

민중

완료

회원정보 수정

Open

PUT

/api/member/{memberId}

Authorization - Jwt

{ "nickname": "닉네임", (String) "introduce": "한줄소개", (String) "password": "비밀번호", (String) "confirmPassword": "비밀번호 확인" (String) }

200 OK { "nickname": "닉네임", (String) "introduce": "한줄소개", (String) }

400 - 입력한 비밀번호, 비밀번호 확인 다름 403 - 수정권한 없음 404 - memberId 프로필 없음

추가

민중

완료

회원정보 조회

Open

GET

/api/member/{memberId}

path variable memberId - 회원 ID

{ "nickname": "닉네임", (String) "introduce": "한줄소개", (String) }

필수

민중

완료

비밀번호 변경

Open

PATCH

/api/member/{memberId}/password

Authorization - Jwt

{ ”password”:”비밀번호” }

200OK { ”password”: “비밀번호” }

필수

민중

완료

피드

피드 조회

Open

GET

/api/post

200 OK [{ ”category” : “카테고리”, ”nickname” : “작성자”, ”title” : “게시물 제목”, ”content” : “내용”, “image”: “img-url”, ”likes” : 123, ”comments” : [{}, {}], ”created_date_time” : “2023-07-26”, ”modified_date_time” : “2023-07-26” }, { ”category” : “카테고리2”, ”nickname” : “작성자2”, ”title” : “게시물 제목2”, ”content” : “내용2”, “image”: “img-url2”, ”likes” : 13, ”comments” : [{}, {}], ”created_date_time” : “2023-07-27”, ”modified_date_time” : “2023-07-27” }]

필수

성호

완료

게시물

게시물 작성

Open

POST

/api/post

Authorization - Jwt

{ ”title”:”제목” ”contents”:”내용” ”category”: “카테고리 종류” }

200 OK { ”post_id”: “id” ”category” : “카테고리”, ”nickname” : “작성자”, ”title” : “게시물 제목”, ”content” : “내용”, “image”: [ { “img-url”:”url”, “fileType”: “파일 타입” } ] ”created_date_time” : “2023-07-26”, }

필수

성호

완료

게시물 단건 조회

Open

GET

/api/post/{id}

200 OK { ”post_id”: “id” ”category” : “카테고리”, ”nickname” : “작성자”, ”title” : “게시물 제목”, ”content” : “내용”, “image”: [ { “img-url”:”url”, “fileType”: “파일 타입” } ] ”likes” : 123, ”created_date_time” : “2023-07-26”, ”modified_date_time” : “2023-07-26” ”comments” : [ { ”comment”: ”코멘트” , “nickname”: “닉네임” } ] ”like”:[ ] }

필수

성호

완료

게시물 수정

Open

PUT

/api/post/{id}

Authorization - Jwt

{ ”title”:”제목” ”contents”:”내용” }

200 OK { ”post_id”: “id” ”category” : “카테고리”, ”nickname” : “작성자”, ”title” : “게시물 제목”, ”content” : “내용”, “image”: [“img-url”] ”created_date_time” : “2023-07-26”, ”modified_date_time” : “2023-07-26” }

필수

성호

완료

게시물 삭제

Open

DELETE

/api/post/{postid}

Authorization - Jwt

200 OK

필수

유진

완료