springfox

สปริงฟ็อกซ์

สถานะการสร้าง	ความคุ้มครอง	Code Analysis

Sonar Cloud

เกี่ยวกับ

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับโครงการนี้ โปรดไปที่เว็บไซต์ Springfox หรือ http://springfox.github.io/springfox/

ลิงค์ที่เป็นประโยชน์

• เอกสารอ้างอิง
• ตัวอย่างที่เก็บ
• แนวทางการบริจาค
• ผู้มีส่วนร่วมหลัก
• แนวทางการพัฒนาและการมีส่วนร่วม
• บันทึกการเปลี่ยนแปลง
• สภาพแวดล้อมการพัฒนา
• คำแนะนำในการเผยแพร่

เริ่มต้นใช้งาน

สำหรับโครงการใหม่ๆ

สำหรับมาเวน

< dependency >
    < groupId >io.springfox</ groupId >
    < artifactId >springfox-boot-starter</ artifactId >
    < version >3.0.0</ version >
</ dependency >

สำหรับเกรเดิล

  implementation " io.springfox:springfox-boot-starter:<version> " 

การย้ายข้อมูลจากสแนปชอตก่อนหน้า

แอพพลิเคชั่น Spring Boot

หมายเหตุ: ชอบข้อเสนอแนะเพื่อปรับปรุงให้ดียิ่งขึ้น

1. ลบการพึ่งพาที่ชัดเจนใน springfox-swagger2
2. ลบคำอธิบายประกอบ @EnableSwagger2...
3. เพิ่มการพึ่งพา springfox-boot-starter
4. Springfox 3.x removes dependencies on guava and other 3rd party libraries (not zero dep yet! depends on spring plugin and open api libraries for annotations and models) so if you used guava predicates/functions those will need to transition to java 8 function interfaces .

การย้ายข้อมูลจากเวอร์ชัน 2.x ที่มีอยู่

แอพพลิเคชั่น Spring Boot

หมายเหตุ: ชอบข้อเสนอแนะเพื่อปรับปรุงให้ดียิ่งขึ้น

1. Remove explicit dependencies on springfox-swagger2
2. ลบคำอธิบายประกอบ @EnableSwagger2
3. Add the springfox-boot-starter dependency
4. Springfox 3.x removes dependencies on guava and other 3rd party libraries (not zero dep yet! depends on spring plugin and open api libraries for annotations and models) so if you used guava predicates/functions those will need to transition to java 8 function interfaces
5. หากคุณใช้ WebMvc แต่คุณไม่ได้ใช้คำอธิบายประกอบ @EnableWebMvc ให้เพิ่มคำอธิบายประกอบนี้

mvc สปริงปกติ

หมายเหตุ: ชอบข้อเสนอแนะเพื่อทำให้ประสบการณ์นี้ดีขึ้น

1. ลบการพึ่งพาที่ชัดเจนใน springfox-swagger2
2. เพิ่ม @EnableOpenApi สำหรับ open API (และ @EnableSwagger2WebMvc หรือ @EnableSwagger2WebFlux สำหรับเวอร์ชันเก่า)
3. เพิ่มห้องสมุด springfox-oas
4. Springfox 3.x ลบการพึ่งพาฝรั่งและไลบรารีของบุคคลที่สามอื่น ๆ (ยังไม่เป็นศูนย์ dep! ขึ้นอยู่กับปลั๊กอินของสปริงและไลบรารี api แบบเปิดสำหรับคำอธิบายประกอบและโมเดล) ดังนั้นหากคุณใช้เพรดิเคต / ฟังก์ชันของฝรั่ง สิ่งเหล่านั้นจะต้องเปลี่ยนไปใช้อินเทอร์เฟซฟังก์ชัน java 8

ใบอนุญาต

ลิขสิทธิ์ 2015 Marty Pitt - @martypitt, Dilip Krishnan - @dilipkrish, Adrian Kelly - @adrianbk,

ได้รับอนุญาตภายใต้ Apache License เวอร์ชัน 2.0 ("ใบอนุญาต"); คุณไม่สามารถใช้ไฟล์นี้ได้เว้นแต่จะเป็นไปตามใบอนุญาต คุณสามารถขอรับสำเนาใบอนุญาตได้ที่ apache.org/licenses/LICENSE-2.0

เว้นแต่กฎหมายที่ใช้บังคับกำหนดหรือตกลงเป็นลายลักษณ์อักษร ซอฟต์แวร์ที่เผยแพร่ภายใต้ใบอนุญาตนี้จะถูกแจกจ่าย "ตามที่เป็น" โดยไม่มีการรับประกันหรือเงื่อนไขใดๆ ทั้งโดยชัดแจ้งหรือโดยนัย ดูใบอนุญาตสำหรับภาษาเฉพาะที่ควบคุมการอนุญาตและข้อจำกัดภายใต้ใบอนุญาต

ใบอนุญาต