검색 API

Get Search List

홈 화면 게시글 검색 결과 리스트 가져오기

• url

  /v1/board/search?page=1&size=20

• method

  GET

• header

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

• query params

  method	parameter	Description	Required
  size	Integer	한 페이지 당 조회 갯 수 (default : 20)
  page	Integer	조회할 페이지 번호 (default : 0)

• request body

  {
      "keywords": "농구 용병"
  }
  

  Field	Type	Description	Example	Required
  keywords	String	검색어(default:전체 조회)	"농구 용병"

Response

• success response

  • body

    {
        "status": 200,
        "success": true,
        "message": "글 목록 조회 성공"
        "data": [
            {
                "boardId": 1,
                "hostId": 3,
                "hostName": "짹짹",
                "title": "급하게 농구 용병 3명 구합니다!",
                "groupStatus": "모집중",
                "exercise": "농구",
                "city": "은평구",
                "isBookMark": true
            },
            {
                "boardId": 2,
                "hostId": 5,
                "hostName": "퐁퐁달퐁",
                "title": "농구 용병 구합니다!",
                "groupStatus": "모집완료",
                "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	호스트 닉네임	"짹짹"	O
    data.title	String	게시판 제목	"같이 중랑천 달리실 분!"	O
    data.groupStatus	String	게시판 state	"모집중"	O
    data.exercise	String	모집 운동 카테고리	"축구"	O
    data.city	String	모집 위치	"강남구"	O
    data.isBookMark	Boolean	북마크 활성화 여부	true/false	O

• fail response

  • request body 값이 비어있는 경우

  {
      "status": 400,
      "success": false,
      "message": "필요한 값이 없습니다"
  }
  

  • access token이 없는 경우

  {
      "status": 400,
      "success": false,
      "message": "토큰이 없습니다."
  }
  

  • access token이 만료 되었을 경우/유효하지 않은 토큰인 경우

  {
      "status": 401,
      "success": false,
      "message": "access token refresh가 필요합니다."
  }
  

  • 서버 내부 오류

  {
      "status": 500,
      "success": false,
      "message": "서버 내부 오류"
  }
  

  Field	Type	Description	Example	Required
  status	integer	HTTP STATUS CODE	500	O
  success	boolean	성공 여부	false	O
  message	String	서버 내부 오류 실패 메세지		O