검색 API - Yapp-17th/Android_2_Backend GitHub Wiki

Base URL

http://101.101.219.23/api/board-service/

Search Board

게시판 키워드 검색

Request

• url

  /v1/board/search?keyword=농구,3명

• method

  GET

• header

  method	parameter	Description	Required
  Authorization	Bearer {token}	Bearer type access token	O

• request param

  Field	Type	Description	Example	Required
  size	Integer	한 페이지 당 조회 갯 수 (default : 20)
  page	Integer	조회할 페이지 번호 (default : 0)
  keyword	String List	키워드		O

Response

• success response

  • body

    {
        "status": 200,
        "success": true,
        "message": "글 목록 조회 성공"
        "data": [
            {
                "boardId": 1,
                "hostId": 3,
                "hostName": "짹짹",
                "title": "급하게 농구 용병 3명 구합니다!",
                "groupStatus": {
                    "code": 0,
                    "name": "모집 중"
                },
                "exercise": "농구",
                "city": "은평구",
                "isBookMark": true
            },
            {
                "boardId": 2,
                "hostId": 5,
                "hostName": "퐁퐁달퐁",
                "title": "같이 중랑천 달리실 분!",
                "groupStatus": {
                    "code": 0,
                    "name": "모집 중"
                },
                "exercise": "달리기",
                "city": "중랑구",
                "isBookMark": false
            },
            ...
        ]
    }
    

    Field	Type	Description	Example	Required
    status	integer	HTTP STATUS CODE	200	O
    success	boolean	성공 여부	true	O
    message	String	게시판 조회 성공 메세지		O
    data	List	게시판 정보 리스트		O
    data.boardId	Long	게시판 번호	1	O
    data.hostId	Long	호스트 번호	1	O
    data.hostName	String	호스트 닉네임	"짹짹sut	O
    data.title	String	게시판 제목	"같이 중랑천 달리실 분!"	O
    data.groupStatus		게시판 state	0: 모집중, 1: 모집 완료, 2: 활동완료, 3: 모임취소	O
    data.groupStatus.code	Integer	state code	0	O
    data.groupStatus.name	String	state name	"모집중"	O
    data.exercise	String	모집 운동 카테고리	"축구"	O
    data.city	String	모집 위치	"강남구"	O
    data.isBookMark	Boolean	북마크 활성화 여부	true/false	O

• fail response

  {
      "status":{{Integer}},
      "success": {{Boolean}},
      "responseType": {{String}},
      "message": {{String}}
  }
  

  Field	Type	Description	Example	Required
  status	integer	HTTP STATUS CODE	500	O
  success	boolean	성공 여부	false	O
  responseType	String	오류 실패 메세지	"USER_NOT_FOUND"	O
  message	String	오류 실패 메세지	"사용자를 찾을 수 없습니다"	O

  status	success	ResponseType	message	상황
  401	false	"INACTIVE_USER_FAIL"	"회원 가입이 필요합니다."	탈퇴한 사용자가 게시판 검색 요청을 시도했을 경우
  403	false	"SUSPENDED_USER_FAIL"	"신고로 정지된 사용자입니다."	정지된 사용자가 게시판 검색 요청을 시도했을 경우
  400	false	"USER_NOT_FOUND"	"사용자를 찾을 수 없습니다"	검색을 요청하는 사용자가 데이터베이스에 없을 경우
  400	false	"INVALID_METHOD"	"메소드 유형이 잘못 되었습니다."	GET이 아닌 다른 메소드로 요청한 경우
  500	false	"INTERNAL_SERVER_ERROR"	"서버 내부 오류"	서버 내부 오류