เอกสารอ้างอิง API สำหรับ Forge

เทมเพลต ตัวสร้างเอกสาร API นี้เปลี่ยนการกำหนดจุดเชื่อมต่อ, ไฟล์ schema, และหมายเหตุการใช้งานให้เป็นเอกสารอ้างอิงที่เรียบร้อย มันถูกสร้างขึ้นเพื่อให้คำอธิบายจุดเชื่อมต่อ, ฟิลด์คำขอและคำตอบ, หมายเหตุการรับรองความถูกต้อง, และ payload ตัวอย่างเป็นไปในแนวเดียวกัน โครงสร้างนี้ช่วยให้ทีมสามารถจัดทำเอกสาร API ได้รวดเร็วขึ้นในขณะที่รักษาความสอดคล้องกับสัญญาจริงแทนข้อความเติมเต็มทั่วไป

เหมาะสำหรับวิศวกรแพลตฟอร์ม, ทีมแบ็กเอนด์, และนักเขียนประสบการณ์นักพัฒนาที่ดูแล API สาธารณะหรือภายใน Prompt ช่วยกระตุ้นให้โมเดลรายชื่อพารามิเตอร์ที่จำเป็น, พารามิเตอร์ตัวเลือก, รหัสสถานะ, และข้อผิดพลาดทั่วไปในรูปแบบที่นักพัฒนาสามารถสแกนได้อย่างรวดเร็ว นอกจากนี้ยังรองรับ API เวอร์ชัน ซึ่งมีประโยชน์เมื่อคุณต้องการเอกสารแยกสำหรับ v1 และ v2 หรือเมื่อจำเป็นต้องระบุการเลิกใช้งานอย่างชัดเจน ใช้ได้ทุกครั้งที่ schema มีการเปลี่ยนแปลงและเอกสารต้องอัปเดตโดยไม่ต้องเขียนใหม่ด้วยมือ

ปรับแต่งเทมเพลตโดยใส่ {{API_SPEC}}, {{AUTH_METHOD}}, และ {{TARGET_READERS}} เพิ่ม {{EXAMPLE_REQUESTS}}, {{ERROR_CODES}}, และ {{VERSION}} เพื่อสร้างหน้าคำอ้างอิงที่สมบูรณ์ยิ่งขึ้น ผลลัพธ์ควรเป็นคู่มือ API ที่มีตารางจุดเชื่อมต่อ, ตัวอย่างคำขอ, ตัวอย่างคำตอบ, และหมายเหตุเกี่ยวกับอัตราการใช้งานหรือกรณีขอบเขต เพื่อให้ได้ผลลัพธ์ดีที่สุด ควรรวม URL ฐานที่แน่นอนและแนวทางการตั้งชื่อใด ๆ เพื่อให้โมเดลสามารถสะท้อนรูปร่างและคำศัพท์ของ API จริงของคุณได้