วิธีอ่านเอกสาร API
คุณจะต้องใช้ชีวิตอยู่กับเอกสาร ดังนั้นนี่คือวิธีหาสิ่งที่คุณต้องการอย่างรวดเร็วโดยไม่ต้องอ่านทั้งหมด สำหรับ ไหนก็ตาม ให้มองหาห้าสิ่งนี้:
- เมธอดและ —
GET /forecastมันทำอะไร บอกในสองคำ - การยืนยันตัวตน (Authentication) — มันต้องการ header หรือ key แบบไหน โดยปกติจะมีหนึ่งส่วนที่ใช้ร่วมกันสำหรับทั้ง API
- พารามิเตอร์ — ข้อมูลนำเข้าที่คุณส่งได้ (ในที่นี้คือ
city) ตัวไหนจำเป็น และชนิดของมัน - ตัวอย่างคำตอบ — รูปทรง ที่คุณจะได้กลับมา นี่คือของดี คัดลอกมันไว้เลย
- Error (ข้อผิดพลาด) — สิ่งที่กลับมาเมื่อมีอะไรผิดพลาด และรหัสสถานะ (
401ไม่ได้รับอนุญาต,404หาไม่พบ,429ถูกจำกัดอัตรา)
เอกสารที่ดีจะมีตัวอย่างคำขอและคำตอบที่คัดลอกวางใช้ได้เลย โค้ดสองก้อนนั้นบอกคุณได้มากกว่าย่อหน้าข้อความยาวๆ — เก็บมันแล้วส่งให้ AI