ตัวดูและทดสอบ OpenAPI / Swagger

เรนเดอร์เอกสารสเปก OpenAPI/Swagger (YAML/JSON) เป็นหน้าต่างเอกสารแบบโต้ตอบ

เกี่ยวกับ ตัวดูและทดสอบ OpenAPI / Swagger — คู่มือการใช้งาน

หมวดหมู่: DevOps และมาตรฐาน ประมวลผลบนเบราว์เซอร์ 100%

โปรแกรมดู OpenAPI (OpenAPI Viewer) คือเครื่องมืออ่านเอกสารประกอบฝั่งไคลเอนต์สำหรับตรวจสอบสัญญา (contract) ของ RESTful API โดยสามารถเรนเดอร์ข้อกำหนด Swagger 2.0 และ OpenAPI 3.0 / 3.1 ทั้งในรูปแบบ JSON หรือ YAML ได้โดยตรงโดยไม่ต้องติดตั้ง Swagger UI ภายในเครื่องหรือพึ่งพาคลาวด์ภายนอก

มาพร้อมแถบด้านข้างที่จัดหมวดหมู่การนำทางสำหรับทุกเอนด์พอยต์อย่างเป็นระเบียบ แสดงทั้งพาธ (paths), เมธอด HTTP (GET, POST, PUT, DELETE), พารามิเตอร์ส่วนหัว (header parameters), คิวรีสตริง (query strings), เนื้อหาคำขอ (request bodies) แบบมีโครงสร้าง, รหัสตอบกลับ HTTP และสคีมาข้อมูล (data schemas)

#openapi #swagger #api #docs #rest #yaml #json

คุณสมบัติและความสามารถหลัก

  • รองรับข้อกำหนด Swagger 2.0 และ OpenAPI 3.0 / 3.1 ทั้งในรูปแบบ JSON และ YAML
  • แถบด้านข้างแบบอินเทอร์แอ็กทีฟแสดงรายการเอนด์พอยต์ที่จัดหมวดหมู่ เมธอด HTTP และรหัสสถานะ
  • การแก้ปัญหาการอ้างอิงสคีมา `$ref` เชิงลึกเพื่อแสดงโมเดลข้อมูลแบบซ้อนกันและข้อจำกัดของพร็อพเพอร์ตี้
  • แจงส่วนข้อมูลแบบออฟไลน์บนฝั่งไคลเอนต์ 100% ช่วยรักษาความปลอดภัยของสัญญา API ภายในองค์กร

วิธีใช้งาน

  1. 1

    วางข้อความ `swagger.json` หรือ `openapi.yaml` ของคุณ หรืออัปโหลดไฟล์ข้อกำหนดโดยตรง

  2. 2

    เลือกดูเอกสาร API ที่จัดโครงสร้างและเรนเดอร์ในตัวแสดงผลแบบอินเทอร์แอ็กทีฟ

  3. 3

    ขยายเอนด์พอยต์ใดก็ได้เพื่อตรวจสอบเฮดเดอร์ของคำขอ สคีมาเพย์โหลดของคำขอ และตัวอย่างการตอบกลับ

ตัวอย่างการใช้งานทั่วไป

  • → ตรวจสอบนิยาม API ของแบ็กเอนด์โดยไม่ต้องตั้งค่าเซิร์ฟเวอร์ Swagger UI แยกต่างหาก
  • → ตรวจสอบความถูกต้องเบื้องต้นของข้อกำหนด OpenAPI ที่เขียนด้วยตนเองเพื่อหาตัวชี้ `$ref` ที่ไม่ถูกต้อง
  • → จัดเตรียมข้อมูลอ้างอิงสคีมาที่แม่นยำให้กับวิศวกรฟรอนต์เอนด์ระหว่างการเชื่อมต่อ API

เครื่องมือที่เกี่ยวข้อง

คำถามที่พบบ่อยและความเป็นส่วนตัว

เครื่องมือนี้สามารถอ่านข้อกำหนด YAML ได้โดยตรงหรือไม่?

ได้ ตัวแจงส่วน YAML ในตัวสามารถประมวลผลข้อกำหนดสัญญา OpenAPI ทั้งรูปแบบ `.yaml` และ `.json` ได้อย่างสมบูรณ์ภายในเบราว์เซอร์

ข้อกำหนด API ที่เป็นกรรมสิทธิ์ของฉันจะถูกอัปโหลดไปยังเซิร์ฟเวอร์ภายนอกหรือไม่?

ไม่ การแจงส่วนเอกสารและการเรนเดอร์สคีมาทั้งหมดทำงานอยู่ภายในหน่วยความจำของเบราว์เซอร์ของคุณเท่านั้น