โพสต์บน: Dec 1, 2016
คุณสามารถเพิ่มเอกสารประกอบไปยังวิธีและทรัพยากรของคุณสำหรับ API ที่สร้างโดยใช้ Amazon API Gateway ซึ่งจะทำให้ผู้ใช้ API เข้าใจ API ของคุณได้อย่างง่ายดาย สามารถเพิ่มเอกสารประกอบสำหรับ API ของคุณโดยตรงได้โดยใช้ Console ของเกตเวย์ API, CLI และ SDK หรือเพียงระบุโดยใช้แท็กเอกสารประกอบในนิยาม Swagger สำหรับ API คุณสามารถใช้เอกสารประกอบซ้ำในลักษณะ API ทั่วไป ตัวอย่างเช่น คุณสามารถควบคุมเอกสารประกอบข้อผิดพลาดมาตรฐานได้ในครั้งเดียว และใช้เอกสารดังกล่าวในการตอบสนองของ API ต่างๆ โดยไม่ต้องทำเนื้อหาซ้ำ ช่วยให้บันทึก API ของคุณและกำจัดข้อผิดพลาดของการ “คัดลอก-วาง” ที่อาจเกิดขึ้นในสตริงที่ซ้ำกัน เมื่อเผยแพร่เอกสารประกอบของคุณโดยเป็นส่วนหนึ่งของขั้นตอน API แล้ว สามารถส่งออกโดยใช้คุณสมบัติการส่งออกของ Swagger และทำให้พร้อมใช้งานในพอร์ทัล Developer ของคุณ
เกตเวย์ API มีเวิร์กโฟลว์ที่เป็นอิสระสำหรับนิยาม API และเอกสารประกอบ API ช่วยให้ Developer ของ API และนักเขียนทางเทคนิคทำงานไปพร้อมกันและนำเข้า Swagger แยกจากกันโดยใช้ Console, CLI และ SDK
สำหรับข้อมูลเพิ่มเติม โปรดดูการบันทึก API ของเกตเวย์ API