1. API 소개
이 API는 위도(latitude), 경도(longitude), 날짜를 입력하여 해당 위치에 대한 기상 예보 정보를 조회할 수 있는 기능을 제공합니다. 이를 통해 기상 상태를 실시간으로 확인하고 예보 데이터를 수신할 수 있습니다.
2. 인증 방법
Weather API는 사용자 인증을 위해 Swagger UI에서 Basic Authorize 인증 방식을 제공합니다.
인증 절차는 다음과 같습니다:
1.
우측 상단의 [Authorize] 버튼을 클릭합니다.
2.
팝업 창에 제공받은 인증 정보(아이디, 비밀번호)를 입력합니다.
3.
입력 후 다시 [Authorize] 버튼을 클릭하여 인증을 진행합니다.
4.
인증이 완료되면 [Close] 버튼을 클릭하여 인증 창을 닫습니다.
Swagger UI에서 호출되는 모든 API 요청에 인증 토큰이 자동으로 포함되어 전송됩니다.
3. 요청 정보
3-1. 요청 정보
Request URL : [GET] https://insight.seavantage.com/api/weather/forecast/{date}
3-2. 실행 순서
1.
Swagger 문서에서 우측 상단의 Select a definition 메뉴에서 Weather 선택
2.
/weather/forecast 경로로 이동
3.
[Try it Out] 클릭 → 입력창 활성화
4.
아래 입력하는 요청 Parameters 조건에 따라 입력
•
longitude : 경도
ex) 65.593025
•
latitude : 위도
ex) 23.55944333
•
date : 날짜 (입력한 날짜 기준으로 -4일전부터 +15일 후까지의 예보 정보를 조회)
ex) 2024-01-01 00:00
5.
[Execute] 버튼 클릭
6.
하단 응답 영역에서 등록 결과 확인
4. 응답 정보
응답 예시{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2024-12-01T12:00:00",
"response": [
{
"current_u": 10,
"current_v": 12,
"dateTime": "2025-05-15T10:05:27.750Z",
"longitude": 123.456,
"latitude": 12.345,
"pressure": 1013.25,
"windSpeed": 10.5,
"windDirection": 180,
"waterTemperature": 25,
"waveHeight": 2.5,
"waveDirection": 90,
"wavePeriod": 5,
"currentSpeed": 1,
"currentDirection": 180
}
]
}
JavaScript
복사
응답 필드 상세 설명필드명 (Attr) | 예시 값 (Example) | 설명 (Desc) |
code | 200 | 응답 상태 코드 (HTTP status code와 동일하게 사용됨)코드 목록은 아래 참조 |
message | success | 응답 메시지 (상태에 따른 설명) |
error | false | 오류 여부
(true: 오류 발생, false: 정상 처리) |
timestamp | 2025-05-15T10:56:59.034880881 | 응답 생성 시각 (UTC 기준) |
response | null 또는 Object | 응답 본문 데이터
화물 존재시 데이터 객체, 미존재시 null |
응답 코드 종류 (code 필드 기준)코드 | 설명 |
201 | 정상 처리 (Created) |
400 | 잘못된 파라미터 (Bad Request) |
401 | 인증 필요 (Unauthorized) |
403 | 권한 없음 (Forbidden) |
422 | 처리 불가 (Unprocessable Entity) |
429 | 요청 과다 (Too Many Requests) |
Depth 1 필드 설명Attr | Example | Desc |
current_u | 10 | 수평 기준, 조류 |
current_v | 12 | 수직 기준, 조류 |
dateTime | 2025-05-15T10:05:27.750Z | 발생 시간 |
longitude | 123.456 | 경도 |
latitude | 12.345 | 위도 |
pressure | 1013.25 | 해수면에서의 대기압 |
windSpeed | 10.5 | 해수면 풍속 |
windDirection | 180 | 해수면 풍향 |
waterTemperature | 25 | 수온 |
waveHeight | 2.5 | 파도의 높이 |
waveDirection | 90 | 파도의 방향 |
wavePeriod | 5 | 파도 주기 |
currentSpeed | 1 | 조류 속도? |
currentDirection | 180 | 조류 방향? |