기본 API

거주 지역 리스트

Request

• url

  /v1/address/city

• method

  GET

Response

• success response

  {
      "result": {
          "type": "city",
          "status": 200,
          "message": "거주 지역 리스트 조회 성공",
          "data": [
              {
                  "id": 1,
                  "name": "강남구" 
              },
              {
                  "id": 2,
                  "name": "강동구"
              },
              ...   
          ]
      },
      "error": null
  }
  

  Field	Type	Description	Example	Required
  result.type	String	list type	"city"	O
  result.status	Integer	HTTP status code	200	O
  result.message	String			O
  result.data	list		[{"id": 1,"name": "강남구"},{"id": 2,"name": "강동구"}, ...]	O
  result.data.id	Integer		1	O
  result.data.name	String		"강남구"	O

• fail response

  • 서버 내부 오류

  {
      "result": null,
      "error":{
          "type": "city",
          "status": 500,
          "message": "거주 지역 리스트 조회 실패, 서버 내부 오류"
      }
  }
  

  Field	Type	Description	Example	Required
  error.type	String	list type	"city"	O
  error.status	Integer	HTTP status code	500	O
  error.message	String	에러 메세지		O

운동 목록 리스트

Request

• url

  /v1/exercise

• method

  GET

Response

• success response

  {
      "result": {
          "type": "exercise",
          "status": 200,
          "message": "운동 목록 리스트 조회 성공",
          "data": [ 
              {
                  "id": 1,
                  "name": "축구" 
              },
              {
                  "id": 2,
                  "name": "농구"
              },
              ... 
          ]
      },
      "error": null
  }
  

  Field	Type	Description	Example	Required
  result.type	String	list type	"exercise"	O
  result.status	Integer	HTTP status code	200	O
  result.message	String			O
  result.data	list		["축구", "야구", ...]	O

• fail response

  {
      "result": null,
      "error": {
          "type": "exercise",
          "status": 500,
          "message": "운동 목록 리스트 조회 실패, 서버 내부 오류"
      }
  }
  

  Field	Type	Description	Example	Required
  error.type	String	list type	"exercise"	O
  error.status	Integer	HTTP status code	500	O
  error.message	String	에러 메세지		O