Cara membaca dokumentasi API
Kamu akan hidup di dalam dokumentasi , jadi begini cara mendapatkan apa yang kamu butuhkan dengan cepat tanpa membaca semuanya. Untuk setiap , cari lima hal:
- Metode dan —
GET /forecast. Apa yang dilakukannya, dalam dua . - Autentikasi — header atau kunci apa yang dibutuhkan. Biasanya satu bagian bersama untuk seluruh API.
- Parameter — input yang bisa kamu kirim (di sini,
city), mana yang wajib, dan tipenya. - Contoh respons — bentuk yang akan kamu terima. Ini emas; salin saja.
- Error — apa yang dikembalikan saat ada yang salah, dan kode statusnya (
401tidak berwenang,404tidak ditemukan,429terkena batas laju).
Dokumentasi yang bagus menyertakan contoh request dan response yang bisa langsung disalin-tempel. Kedua potongan itu memberitahumu lebih banyak daripada paragraf-paragraf prosa — ambil dan berikan ke AI.