Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API #50

Closed
nohgijin opened this issue Jan 12, 2021 · 2 comments
Closed

API #50

nohgijin opened this issue Jan 12, 2021 · 2 comments
Labels
Doc 문서

Comments

@nohgijin
Copy link
Contributor

nohgijin commented Jan 12, 2021

에러처리

200
404
500 이상

⭐️Log In

Request

Endpoint

POST /api/login

Body

Property Type Description
id string User Github ID

language는 브라우저단에 저장
따라서 수정도 필요없음. 브라우저에서 수정하면됨.

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 Jjim List

Request

Endpoint

GET /api/jjims

Response

Property Type Description
jjimList Jjim[] Get Jjim list

⭐️Get a History Data

Request

Endpoint

GET /api/history

Response

Property Type Description
historyList History[] Get History list

⭐️Get a Point

Request

Endpoint

GET /api/point

Response

Property Type Description
point int Get point information

⭐️Modify a Point

Request

Endpoint

PUT /api/point

Body

Property Type Description
point int amount of point

Response

Property Type Description
success boolean Whether modified or not
@nohgijin nohgijin pinned this issue Jan 12, 2021
@nohgijin nohgijin added the Doc 문서 label Jan 12, 2021
@YeonJeongLee00
Copy link
Contributor

YeonJeongLee00 commented Jan 13, 2021

⭐️Get ProjectList

Request

Endpoint

GET /api/category/:categoryId

Response

Property Type Description
projectList Project[] Get Project list

⭐️Get CategoryList

Request

Endpoint

GET /api/category

Response

Property Type Description
categoryList Category[] Get Category list

@dbckdgjs369
Copy link
Contributor

dbckdgjs369 commented Jan 13, 2021

⭐️PopularPage

Request

Get Endpoint

GET /api/popular

Response

Property Type Description
popularProjectList PopularList[] Popular Projects List

⭐️Project Description Page

Request

Endpoint

GET /api/project/:projectId

Response

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Doc 문서
Projects
None yet
Development

No branches or pull requests

3 participants