Skip to content

API Specification

Yongsung Heo edited this page Apr 19, 2019 · 7 revisions

API Specification

Common Headers

  • Authorization: Bearer + TOKEN

Error Response Body

Name Type Description
error object error object. client can recognize the error status through this filed's existence.
message number essential. message number presented to user.
detail string optional. information string used for debugging.

Examples

{
    "error": {
        "message": 400.
        "detail": "KINDS_OF_CODE_CAN_BE_HERE."
    }
}

User

Users who connect to server.

Create New User : POST /api/v1/auth/signup

Get User Auth Token : POST /api/v1/auth/login

Update User Password : POST /api/v1/users/changepwd

Update User Info : POST /api/v1/users/changeinfo

Invalidate User Auth Token : GET /api/v1/users/logout

Travel

Set of Travel cards.

Create New Travel : POST /api/v1/my/travels

Get List Of Travels : GET /api/v1/my/travels

Get Specific Travel : GET /api/v1/my/travels/:travelId

Update Specific Travel : PUT /api/v1/my/travels/:travelId

Delete Specific Travel : DELETE /api/v1/my/travels/:travelId

TravelCard

Create New TravelCard : POST /api/v1/my/travelcards/:travelId

Get List Of TravelCards : GET /api/v1/my/travelcards/:travelId

Update Specific TravelCard : PUT /api/v1/my/travelcards/:travelCardId

Delete Specific TravelCard : DELETE /api/v1/my/travelcards/:travelCardId

Clone this wiki locally