[Web] FAQ로 API응답 설명하기

시작하며

---

저는 잘 있답니다~~!!

요즘은 코로나가 심해지면서 외출도 거의 안하게 됩니다.

최근 한 달 가까이는, 알고리즘 공부 와 프로젝트 에 시간을 썼는데요!

당분간은 쭉 그럴꺼 같아요!!!

(프로젝트를 소개할 수 있는 날이 빨리 오면 좋겠습니닷 ㅎㅎㅎㅎㅎ)

전 공부도 하고, 고양이와 함께 잘 있어요~~!!!

ps. 고양이 몸집이 엄청 커졌어요 😮

API 응답 아이디어

---

오늘은 급하게 날씨 API를 사용할 일이 있어서, 무료로 날씨 데이터를 제공해주는 OpenWeather 을 사용해봤습니다.

그런데, API를 형식에 맞게 보냈음에도, 원하는 응답을 받지 못했습니다.

다만, 어느 사이트로 가보라는 안내 글이 있었는데요!

안내하는 사이트로 가보니 '무료 계정으로는 제한이 있는 API인 경우의 응답' 이라는 것을 확인할 수 있었습니다.

만약 위와 같은 상세한 설명이 없었더라면, “형식이 틀렸나?” 부터 시작해서 여러 원인을 추측하면서 응답 값을 확인해야 했을텐데, 수고를 덜어주었습니다!!

이렇게 에러에 대한 상세 설명을 FAQ로 제공하는 것 이 좋은 아이디어라고 생각해서 킵 해둡니다!

해당 링크

OpenWeather

---

필요하신 분들은 아래 내용을 참고해주세요~~

1. Docs

: https://openweathermap.org/api/one-call-api

2. API 명세

아래 예시는 ‘서울시 서초구’ 위도/경도 를 기준으로 확인하였습니다.

1. URL : https://api.openweathermap.org/data/2.5/onecall

2. Request param

   KEY	VALUE	DESCRIPTION
   lat	37.482155	위도
   lon	127.00299	경도
   exclude	hourly,minutely	제외할 정보
   units	metric	측정 단위(섭씨)
   lang	kr	언어
   appid	[개인 키]	라이센스 키

3. Response body

   

   cf) 아이콘은 “http://openweathermap.org/img/w/” + icon + “.png” 로 가져옵니다.

4. Example

   https://api.openweathermap.org/data/2.5/onecall?lat=37.482155&lon=127.00299&exclude=hourly,minutely&units=metric&lang=kr&appid=[개인 키]
   

3. 요금제

: 요금제 별 API호출 건수는 다음과 같습니다.

오늘도 수고 많았어요~~~ 😴