API 문서를 읽는 법

당신은 API 문서 속에서 살게 될 테니, 전부 읽지 않고도 필요한 걸 빨리 얻는 법을 알아두자. 어떤 엔드포인트든, 다섯 가지를 찾아라.

• 메서드와 URL — GET /forecast. 무슨 일을 하는지, 두 토큰으로.
• 인증 — 어떤 header나 key가 필요한지. 보통 API 전체에 대해 공유되는 한 섹션이다.
• 파라미터 — 보낼 수 있는 입력값들 (여기서는 city), 무엇이 필수인지, 그리고 그것들의 타입.
• 예시 응답 — 돌려받게 될 JSON 모양. 이건 금덩이다. 복사해두라.
• 에러 — 뭔가 잘못됐을 때 무엇이 돌아오는지, 그리고 상태 코드 (401 권한 없음, 404 찾을 수 없음, 429 속도 제한).

좋은 문서에는 복사-붙여넣기 가능한 예시 요청과 응답이 들어 있다. 그 두 토막은 문단으로 된 산문보다 더 많은 걸 알려준다 — 그것들을 챙겨서 AI에게 건네라.