Swagger UI อนุญาตให้ทุกคนไม่ว่าจะเป็นทีมพัฒนาของคุณหรือผู้บริโภคปลายทางของคุณ - เพื่อให้เห็นภาพและโต้ตอบกับทรัพยากรของ API โดยไม่ต้องมีตรรกะการใช้งานใด ๆ มันถูกสร้างขึ้นโดยอัตโนมัติจากข้อกำหนดของ OpenAPI (เดิมชื่อ Swagger) ของคุณด้วยเอกสารภาพทำให้ง่ายต่อการใช้งานด้านหลังและการบริโภคด้านลูกค้า
- ต้องการทำคะแนนการบริจาคโอเพนซอร์ซง่าย ๆ หรือไม่? ตรวจสอบฉลากฉบับแรกที่ดีของเรา
? ️กำลังมองหา Swagger UI รุ่นเก่าหรือไม่? อ้างถึงสาขา 2.x
ที่เก็บนี้เผยแพร่โมดูล NPM ที่แตกต่างกันสามโมดูล:
เราขอแนะนำอย่างยิ่งให้คุณใช้ swagger-ui แทนที่จะเป็น swagger-ui-dist ถ้าคุณกำลังสร้างแอปพลิเคชันหน้าเดียวเนื่องจาก swagger-ui-dist มีขนาดใหญ่ขึ้นอย่างมาก
หากคุณกำลังมองหา HTML/JS/CSS ธรรมดาให้ดาวน์โหลดรีลีสล่าสุดและคัดลอกเนื้อหาของโฟลเดอร์ /dist ไปยังเซิร์ฟเวอร์ของคุณ
ข้อมูลจำเพาะ OpenAPI ได้รับการแก้ไข 5 ตั้งแต่การสร้างครั้งแรกในปี 2010 ความเข้ากันได้ระหว่าง Swagger UI และข้อกำหนด OpenAPI มีดังนี้:
| Swagger UI เวอร์ชัน | วันที่วางจำหน่าย | ความเข้ากันได้ของ OpenAPI Spec | หมายเหตุ |
|---|---|---|---|
| 5.0.0 | 2023-06-12 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0 | Tag v5.0.0 |
| 4.0.0 | 2021-11-03 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3 | Tag v4.0.0 |
| 3.18.3 | 2018-08-03 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3 | Tag v3.18.3 |
| 3.0.21 | 2017-07-26 | 2.0 | Tag v3.0.21 |
| 2.2.10 | 2017-01-04 | 1.1, 1.2, 2.0 | Tag v2.2.10 |
| 2.1.5 | 2016-07-20 | 1.1, 1.2, 2.0 | Tag v2.1.5 |
| 2.0.24 | 2014-09-12 | 1.1, 1.2 | Tag v2.0.24 |
| 1.0.13 | 2013-03-08 | 1.1, 1.2 | Tag v1.0.13 |
| 1.0.1 | 2011-10-11 | 1.0, 1.1 | Tag v1.0.1 |
Swaggerui ใช้ผ้าพันคอเพื่อรวบรวมการวิเคราะห์การติดตั้งที่ไม่ระบุชื่อ การวิเคราะห์เหล่านี้ช่วยสนับสนุนผู้ดูแลห้องสมุดนี้และทำงานเฉพาะในระหว่างการติดตั้ง package.json ต้องการยกเลิกคุณสามารถตั้ง false ฟิลด์ scarfSettings.enabled
// package.json
{
// ...
"scarfSettings": {
"enabled": false
}
// ...
}
หรือคุณสามารถตั้งค่าตัวแปรสภาพแวดล้อม SCARF_ANALYTICS เป็น false ซึ่งเป็นส่วนหนึ่งของสภาพแวดล้อมที่ติดตั้งแพ็คเกจ NPM ของคุณเช่น SCARF_ANALYTICS=false npm install
คุณจะต้องใช้ JDK ของเวอร์ชัน 7 หรือสูงกว่าตามคำแนะนำที่นี่ https://nightwatchjs.org/guide/getting-started/installation.html#install-selenium-server
การทดสอบการรวมสามารถใช้งานได้ในเครื่องด้วย npm run e2e - ตรวจสอบให้แน่ใจว่าคุณไม่ได้เรียกใช้เซิร์ฟเวอร์ dev เมื่อทำการทดสอบ!
Swagger UI ทำงานใน Chrome รุ่นล่าสุด Safari, Firefox และ Edge
เพื่อช่วยในการย้ายถิ่นนี่เป็นปัญหาที่รู้จักกันในปัจจุบันกับ 3.x รายการนี้จะอัปเดตเป็นประจำและจะไม่รวมคุณสมบัติที่ไม่ได้ใช้ในเวอร์ชันก่อนหน้า
collectionFormat เป็นบางส่วนโปรดเปิดเผยปัญหาหรือช่องโหว่ที่เกี่ยวข้องกับความปลอดภัยใด ๆ โดยส่งอีเมลถึง [email protected] แทนที่จะใช้ตัวติดตามปัญหาสาธารณะ
Swaggerui ได้รับใบอนุญาตภายใต้ใบอนุญาต Apache 2.0 Swaggerui มาพร้อมกับไฟล์ประกาศที่ชัดเจนซึ่งมีประกาศและข้อมูลทางกฎหมายเพิ่มเติม