Skip to content

API Overview

kimsungwon edited this page Feb 13, 2024 · 10 revisions

Auth

Method HTTP Method URL Description Access Level
Login GET /api/v1/google/sign-in Login account -
Login GET /api/v1/google/sign-in/token Exchange code for ID token -
Logout GET /api/v1/auth/sign-out Logout account >= USER

User

REST Method HTTP Method URL Description Access Level
Get GET /api/v1/users/{userId} Get user detail >= USER(In the case of USER, only one's own information can be processed)
Replace PUT /api/v1/users/{userId} Replace a user >= USER(In the case of USER, you can change your own profile. Access level editing is possible only in case of DEVELOPER or higher.)

Review

REST Method HTTP Method URL Description Access Level
Create POST /api/v1/reviews Create a review >= USER
Get GET /api/v1/reviews/{reviewId} Get a review detail -
List GET /api/v1/reviews List reviews -
Replace PUT /api/v1/reviews/{reviewId} Replace a review >= USER(In the case of USER, only one's own information can be processed)
Delete DELETE /api/v1/reviews/{reviewId} Delete a review >= USER(In the case of USER, only one's own information can be processed)
Create POST /api/v1/reviews/{reviewId}/replies Create a review reply >= USER
List GET /api/v1/reviews/{reviewId}/replies List review replies -
Replace PUT /api/v1/reviews/{reviewId}/replies/{replyId} Replace a review reply >= USER(In the case of USER, only one's own information can be processed)
Delete DELETE /api/v1/reviews/{reviewId}/replies/{replyId} Delete a review reply >= USER(In the case of USER, only one's own information can be processed)

Comment

REST Method HTTP Method URL Description Access Level
Create POST /api/v1/comments Create a comment >= USER
List GET /api/v1/comments List comments -
Replace PUT /api/v1/comments/{commentId} Replace a comment >= USER(In the case of USER, only one's own information can be processed)
Delete DELETE /api/v1/comments/{commentId} Delete a comment >= USER(In the case of USER, only one's own information can be processed)
Clone this wiki locally