navicode

API 참고 문서

항목 설명
기본 URL https://navicode.shop/api/search
엔드포인트 GET /api/search
설명 내비코드 또는 상세주소로 데이터를 검색합니다.
Query Parameters query (string, 필수): 검색할 naviCode 값입니다.
예: /api/search?query=#1234
Headers Content-Type: application/json
요청 예시

    const response = await fetch(`/api/search?query=${encodeURIComponent(queryFromURL)}`, {
      method: 'GET',
      headers: {
        'Content-Type': 'application/json'
      }
    });
                                    
응답 형식

    {
      "success": true,
      "results": [
        {
          "name": "Example Name",
          "naviCode": "#1234",
          "detailAddress": "서울시 강남구",
          "latitude": 37.5665,
          "longitude": 126.978
        }
        // 추가 결과 ...
      ]
    }
                                    
에러 응답
  • 400 Bad Request: 잘못된 요청
    
        {
          "success": false,
          "message": "Invalid request format"
        }
                                                
  • 404 Not Found: 검색 결과가 없는 경우
    
        {
          "success": false,
          "message": "검색하신 navicode 또는 주소가 없습니다."
        }
                                                
  • 500 Internal Server Error: 서버 오류
    
        {
          "success": false,
          "message": "DB Query Error",
          "error": "에러 메시지"
        }
                                                

참고 예시

아래 영역에 버튼을 클릭하세요