Skip to content

기본 API

soyeon Park edited this page Oct 17, 2020 · 26 revisions

거주 지역 리스트

Request

  • url

    /list/city

  • method

    GET

Response

  • success response

    {
        "type": "city",
        "status": 200,
        "message": "거주 지역 리스트 조회 성공",
        "items": [ ]
    }
    
    Field Type Description Example Required
    type String list type "city" O
    status Integer HTTP status code 200 O
    message String O
    items list ["종로구", "중구", ...] O
  • fail response

    • 서버 내부 오류
    {
        "type": "city",
        "status": 500,
        "message": "거주 지역 리스트 조회 실패, 서버 내부 오류"
    }
    
    Field Type Description Example Required
    type String list type "city" O
    status Integer HTTP status code 500 O
    message String 에러 메세지 O

운동 목록 리스트

Request

  • url

    /list/exercise

  • method

    GET

Response

  • success response

    {
        "type": "exercise",
        "status": 200,
        "message": "운동 목록 리스트 조회 성공",
        "items": [ ]
    }
    
    Field Type Description Example Required
    type String list type "exercise" O
    status Integer HTTP status code 200 O
    message String O
    items list ["축구", "야구", ...] O
  • fail response

    {
        "type": "exercise",
        "status": 500,
        "message": "운동 목록 리스트 조회 실패, 서버 내부 오류"
    }
    
    Field Type Description Example Required
    type String list type "exercise" O
    status Integer HTTP status code 500 O
    message String 에러 메세지 O

Clone this wiki locally