Skip to content

api명세

gijin noh edited this page Jan 15, 2021 · 11 revisions

에러처리

  • 200
  • 404
  • 500 이상

⭐️Log In

Request

Endpoint

POST /api/login

Body

Property Type Description
id string User Github ID

Response

Property Type Description
success boolean Whether signed in or not

⭐️Log Out

Request

Endpoint

POST /api/logout

Response

Property Type Description
success boolean Whether signed in or not

⭐️Get Schedule Project List

Request

Endpoint

GET /api/schedules

Response

Property Type Description
projectList Project[] Get Schedule Project list

⭐️Get Soon Success List

Request

Endpoint

GET /api/success

Response

Property Type Description
projectList Project[] Get Soon Success Project list

⭐️Get Jjim List

Request

Endpoint

GET /api/user/jjims

Response

Property Type Description
jjimList Jjim[] Get Jjim list

⭐️Create a Jjim

Request

Endpoint

POST /api/user/jjims

Body

Property Type Description
project_id int project id

Response

Property Type Description
jjim_id int created jjim id

⭐️Remove a Jjim

Request

Endpoint

DELETE /api/user/jjims

Body

Property Type Description
jjim_id int jjim id

Response

Property Type Description
success boolean Whether deleted or not

⭐️Get a History Data

Request

Endpoint

GET /api/user/history

Response

Property Type Description
historyList History[] Get History list

⭐️Get a Point

Request

Endpoint

GET /api/user/points

Response

Property Type Description
point int Get point information

⭐️Charging a point

Request

Endpoint

POST /api/user/points

Body

Property Type Description
point int amount of point

Response

Property Type Description
success boolean Whether charged or not

⭐️Funding a Project

Request

Endpoint

POST /api/user/fundings

Body

Property Type Description
project_id int project id
point int amount of point

Response

Property Type Description
success boolean Whether posted or not

⭐️Get a Project List in Cart

Request

Endpoint

GET /api/user/carts

Response

Property Type Description
projectList Cart[] Get a Project List in Cart

⭐️Create a Cart

Request

Endpoint

POST /api/user/carts

Body

Property Type Description
project_id int project id

Response

Property Type Description
cart_id int created cart id

⭐️Modify a cart

Request

Endpoint

PUT /api/user/carts

Body

Property Type Description
Project_id int project id
point int amount of money

Response

Property Type Description
success boolean Whether modified or not

⭐️Remove a Cart

Request

Endpoint

DELETE /api/user/carts

Body

Property Type Description
project_id int project id

Response

Property Type Description
success boolean Whether deleted or not

⭐️Get ProjectList

Request

Endpoint

GET /api/categories/:categoryId/:filterType

Response

Property Type Description
projectList Project[] Get Project list

⭐️Get CategoryList

Request

Endpoint

GET /api/categories

Response

Property Type Description
categoryList Category[] Get Category list

⭐️PopularPage

Request

Endpoint

GET /api/populars

Response

Property Type Description
popularProjectList PopularList[] Popular Projects List

⭐️Project Detail Page

Request

Endpoint

GET /api/projects/:projectId

Response

Property Type Description
projectId int Project’s Unique Id
picture string Project’s Picture
detail string Project’s Description