สิ่งสำคัญ: springdoc-openapi v1.8.0
เป็นโอเพ่นซอร์สรุ่นล่าสุดที่รองรับ Spring Boot 2.x และ 1.x
ขณะนี้การสนับสนุนเพิ่มเติมสำหรับโปรเจ็กต์ springdoc-openapi v1 พร้อมให้ใช้งานแล้วสำหรับองค์กรที่ต้องการการสนับสนุนหลังจากปี 2023
สำหรับรายละเอียดเพิ่มเติม โปรดติดต่อ: [email protected]
springdoc-openapi
อยู่ใน Open Collective หากคุณ ❤️ โครงการนี้พิจารณาเป็นสปอนเซอร์
โครงการนี้ได้รับการสนับสนุนจาก
ไลบรารี Java springdoc-openapi ช่วยในการสร้างเอกสาร API โดยอัตโนมัติโดยใช้โปรเจ็กต์ Spring Boot springdoc-openapi ทำงานโดยตรวจสอบแอปพลิเคชันที่รันไทม์เพื่ออนุมานซีแมนทิกส์ API ตามการกำหนดค่า Spring โครงสร้างคลาส และคำอธิบายประกอบต่างๆ
ไลบรารีจะสร้างเอกสารประกอบในหน้ารูปแบบ JSON/YAML และ HTML โดยอัตโนมัติ เอกสารที่สร้างขึ้นสามารถเสริมได้โดยใช้คำอธิบายประกอบ swagger-api
ห้องสมุดนี้รองรับ:
วิดีโอต่อไปนี้แนะนำห้องสมุด:
สำหรับการรองรับ spring-boot v3 ตรวจสอบให้แน่ใจว่าคุณใช้ springdoc-openapi v2
นี่เป็นโครงการตามชุมชน ไม่ได้รับการดูแลโดย Spring Framework Contributors (Pivotal)
server
: ชื่อเซิร์ฟเวอร์หรือ IPport
: พอร์ตเซิร์ฟเวอร์context-path
: เส้นทางบริบทของแอปพลิเคชัน/v3/api-docs.yaml
springdoc-openapi-ui
ลงในรายการการพึ่งพาโครงการของคุณ (ไม่จำเป็นต้องกำหนดค่าเพิ่มเติม):มาเวน
< dependency >
< groupId >org.springdoc</ groupId >
< artifactId >springdoc-openapi-starter-webmvc-ui</ artifactId >
< version >last-release-version</ version >
</ dependency >
เกรเดิล
implementation ' org.springdoc:springdoc-openapi-starter-webmvc-ui:latest '
# swagger-ui custom path
springdoc.swagger-ui.path =/swagger-ui.html
server
: ชื่อเซิร์ฟเวอร์หรือ IPport
: พอร์ตเซิร์ฟเวอร์context-path
: เส้นทางบริบทของแอปพลิเคชัน/v3/api-docs.yaml
มาเวน
< dependency >
< groupId >org.springdoc</ groupId >
< artifactId >springdoc-openapi-starter-webmvc-api</ artifactId >
< version >last-release-version</ version >
</ dependency >
เกรเดิล
implementation ' org.springdoc:springdoc-openapi-starter-webmvc-ui:latest '
# /api-docs endpoint custom path
springdoc.api-docs.path =/api-docs
springdoc-openapi
ให้เพิ่มคุณสมบัติ springdoc ที่กำหนดเองในไฟล์การกำหนดค่า spring-boot
ของคุณ: # disable api-docs
springdoc.api-docs.enabled =false
หากต้องการสร้างเอกสารประกอบโดยอัตโนมัติ ตรวจสอบให้แน่ใจว่าวิธีการทั้งหมดประกาศการตอบสนองโค้ด HTTP โดยใช้คำอธิบายประกอบ: @ResponseStatus
ไลบรารีใช้แพ็คเกจที่กำหนดค่าอัตโนมัติของแอปพลิเคชัน spring-boot เพื่อสแกนหาคำอธิบายประกอบต่อไปนี้ใน spring bean: OpenAPIDefinition และ Info คำอธิบายประกอบเหล่านี้ประกาศ ข้อมูล API: ชื่อ เวอร์ชัน ใบอนุญาต ความปลอดภัย เซิร์ฟเวอร์ แท็ก ความปลอดภัย และเอกสารภายนอก เพื่อประสิทธิภาพที่ดีขึ้นในการสร้างเอกสาร ให้ประกาศคำอธิบายประกอบ @OpenAPIDefinition
และ @SecurityScheme
ภายใน Bean ที่จัดการโดย Spring
มาเวน
< dependency >
< groupId >org.springdoc</ groupId >
< artifactId >springdoc-openapi-starter-webflux-ui</ artifactId >
< version >last-release-version</ version >
</ dependency >
เกรเดิล
implementation ' org.springdoc:springdoc-openapi-starter-webmvc-ui:latest '
# swagger-ui custom path
springdoc.swagger-ui.path =/swagger-ui.html
ไลบรารี springdoc-openapi
โฮสต์อยู่บนพื้นที่เก็บข้อมูลกลาง maven สามารถดูสิ่งประดิษฐ์ได้ที่สถานที่ต่อไปนี้:
ข่าวประชาสัมพันธ์:
ภาพรวม:
springdoc-openapi มีความเกี่ยวข้องและอัปเดตเป็นประจำเนื่องจากการสนับสนุนอันมีค่าจากผู้ร่วมให้ข้อมูล
ขอขอบคุณทุกท่านสำหรับการสนับสนุนของคุณ!