Skip to content

api.md

Latest commit

 

History

History
157 lines (136 loc) · 2.83 KB

api.md

File metadata and controls

157 lines (136 loc) · 2.83 KB

API Document

USER

GET: /user?uid=[user_id]

  • Load user data
  • parameter
    • uid: (mandatory) user id to get data
  • response 
    {
    "user_id": "",
    "user_idx": 0, // Use to get rank data
    "user_name": ""
}

POST: /user

  • Add user (Create user account)
  • Check each user_id and user_name is unique
  • body 
    {
    "user_id": "",         // mandatory
    "user_name": "",       // mandatory
    "user_password": ""    // mandatory
}
  • response
    • success: 200 / error: 400

PATCH: /user

  • Modify user data
  • body 
    {
    "user_id": "",         // mandatory
    "user_name": "",
    "user_password": ""
}
  • response
    • success: 200 / error: 400

DELETE: /user?uid=[user_id]

  • Delete User Data
  • No plan to make this API




DATA

GET: /data?c=""&o=""

  • Give all data of data table
  • parameter
    • c: (mandatory) column to order
    • o: (mandatory) "desc" or "asc" (descending, ascending order)
    • stage: (optional) Distinction "stage"
  • response 
    [
    {   
        "c_date": DateTime(),
        "user_name": "",
        "stage_id": 0,
        "distance": 0,
        "calorie": 0,
        "score": 0
    },
    ...
]

GET: /data/distance?uidx=0&stage=0

  • Give total distance data of data table
  • parameter
    • uidx: (mandatory) user index
    • stage: (optional) Distinction "stage"
  • response 
    {   
    "total_distance": 0000
}

GET: /data/calorie?uidx=0&stage=0

  • Give total calorie data of data table
  • parameter
    • uidx: (mandatory) user index
    • stage: (optional) Distinction "stage"
  • response 
    {   
    "total_calorie": 0000
}

GET: /data/score?uidx=0&stage=0

  • Give total score data of data table
  • parameter
    • uidx: (mandatory) user index
    • stage: (optional) Distinction "stage"
  • response 
    {   
    "total_score": 0000
}

GET: /data/scoretop?uidx=0&stage=0

  • Give top score data of data table
  • parameter
    • uidx: (mandatory) user index
    • stage: (optional) Distinction "stage"
  • response 
    {   
    "top_score": 0000
}

POST: /data

  • Add user record data
  • body 
    {
    "user_idx": 0,         // mandatory
    "stage_id": 0,         // mandatory
    "distance": 0,         // mandatory
    "calorie": 0,          // mandatory
    "score": 0             // mandatory
}

PATCH: TBD

  • No plan to make this API
  • Rank data is permanently stored on the server

DELETE: TBD

  • No plan to make this API
  • Rank data is permanently stored on the server