RESTFul API 명세에 대하여

[sieunnnn]

REST API 명세

제가 초안을 짜봤는데 여러분들의 의견이 어떤지 듣고 싶습니다! 🤔

회원가입 / 로그인 관련 API

Tag : Auth

POST /api/auth/register

POST /api/auth/login

POST /api/auth/logout

POST /api/auth/password/reset

POST /api/auth/password/reset/callback

유저정보 관련 API

Tag : User

• 특정 유저의 프로필도 포함합니다.
• 유저 정보를 반환하는 api 도 포함합니다.

GET /api/users/me

• 현재 로그인 유저의 유저정보를 요청합니다.

• GET /api/users/me/reload

• 유저 정보 수정 시 유저정보를 다시 캐싱합니다.

GET /api/users/{userId}

• 특정 유저의 프로필을 요청합니다.

PATCH /api/users/

DELETE /api/users/

POST /api/users/verify

• 비밀 번호를 변경하기 전 확인합니다.

PATCH /api/users/change

• 비밀 번호를 변경합니다.

토큰 관련 API

Tag : JWT

POST /api/token/refresh

OAuth2.0 API

Tag : OAuth2.0

GET /api/oauth/authorize/naver

GET /api/oauth/authorize/kakao

GET /api/oauth/authorize/google

피드 관련 API

Tag : Feed

GET /api/feed

플래너 관련 API

Tag : Planner

GET /api/planners

GET /api/planners/{plannerId}

POST /api/planners

PATCH /api/planners

DELETE /api/planners

POST 관련 API

Tag : Post

GET /api/posts

GET /api/posts/{postId}

POST /api/posts

PATCH /api/posts

DELETE /api/posts

Comment 관련 API

Tag : Comment

GET /api/comments

POST /api/comments/{postId}

PATCH /api/comments/{postId}/{commentId}

DELETE /api/comments/{postId}/{commentId}