기본 API - Yapp-17th/Android_2_Backend GitHub Wiki

• Address City List
  • Request
  • Response
• Exercise List
  • Request
  • Response
• User Type Tag List
  • Request
  • Response
• Board Report Type List
  • Request
  • Response
• User Report Type List
  • Request
  • Response

Base URL

http://101.101.219.23/api/base-service/

Address City List

Request

• url

  /v1/address/city

• method

  GET

Response

• success response

  {
    "type": "city",
    "status": 200,
    "message": "SUCCESS",
    "data": [
        {
            "id": 1,
            "name": "종로구"
        },
        {
            "id": 2,
            "name": "중구"
        },
        ...
    ]
  }
  

  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

Exercise List

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		[{"id": 1,"name": "축구"},{"id": 2,"name": "농구"}, ...]	O
  result.data.id	Integer	운동 타입 아이디	1	O
  result.data.name	String	운동 타입 이름	"농구"	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

User Type Tag List

Request

• url

  /v1/user/tag

• method

  GET

Response

• success response

  {
      "result": {
          "type": "userTag",
          "status": 200,
          "message": "유저 태그 리스트 조회 성공",
          "data": [ 
              {
                  "id": 1,
                  "name": "빡겜러" 
              },
              {
                  "id": 2,
                  "name": "즐겜러"
              },
              ... 
          ]
      },
      "error": null
  }
  

  Field	Type	Description	Example	Required
  result.type	String	list type	"userTag"	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": "userTag",
          "status": 500,
          "message": "서버 내부 오류"
      }
  }
  

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

Board Report Type List

Request

• url

  /v1/board/report/type

• method

  GET

Response

• success response

  {
      "result": {
          "type": "boardReportType",
          "status": 200,
          "message": "게시판 신고 타입 리스트 조회 성공",
          "data": [ 
              {
                  "id": 1,
                  "name": "욕설 및 악의성 내용이 포함돼있어요" 
              },
              {
                  "id": 2,
                  "name": "선정적인 내용이 포함돼있어요"
              },
              ... 
          ]
      },
      "error": null
  }
  

  Field	Type	Description	Example	Required
  result.type	String	list type	"boardReportType"	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": "boardReportType",
          "status": 500,
          "message": "서버 내부 오류"
      }
  }
  

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

User Report Type List

Request

• url

  /v1/user/report/type

• method

  GET

Response

• success response

  {
      "result": {
          "type": "userReportType",
          "status": 200,
          "message": "사용자 신고 타입 리스트 조회 성공",
          "data": [ 
              {
                  "id": 1,
                  "name": "중간에 연락이 두절됐어요" 
              },
              {
                  "id": 2,
                  "name": "활동에 참여하지 않았어요"
              },
              ... 
          ]
      },
      "error": null
  }
  

  Field	Type	Description	Example	Required
  result.type	String	list type	"userReportType"	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": "userReportType",
          "status": 500,
          "message": "서버 내부 오류"
      }
  }
  

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