บทความนี้แนะนำตัวอย่างของการใช้ Swagger2 ในโครงการ Spring Boot มันถูกแบ่งปันกับคุณ รายละเอียดมีดังนี้:
เพิ่มการพึ่งพา Swagger2
เพิ่มการพึ่งพา Swagger2 ใน pom.xml
<Ependency> <sderctId> io.springfox </groupId> <ratifactid> SpringFox-Swagger2 </artifactId> <Sersion> 2.2.2 </เวอร์ชัน> </predency> <predency> <roupId> iO.springfox </GroupId>
สร้างคลาสการกำหนดค่า Swagger2
สร้างคลาสการกำหนดค่าของ Swagger2 Swagger2 ในแอปพลิเคชันระดับพร้อมกัน
นำเข้า org.springframework.context.annotation.bean; นำเข้า org.springframework.context.annotation.configuration; นำเข้า Springfox.documentation.builders.apiinfobuilder; นำเข้า springfox.documentation.builders.builders. Springfox.documentation.service.apiinfo; นำเข้า Springfox.documentation.spi.documentationType; นำเข้า Springfox.documentation.spring.web.plugins.docket; นำเข้า Springfox.documentation.swagger2 CREATERESTAPI () {ส่งคืนใบปะหน้าใหม่ (DocumentationType.swagger_2) .apiinfo (apiinfo ()) .select () .apis (requesthandlerselectors.basepackage ("ชื่อแพ็คเกจอินเทอร์เฟซภายนอกของคุณเอง")). } ส่วนตัว apiinfo apiinfo () {ส่งคืน apiinfobuilder ใหม่ () .title ("neo4j resful apis") .description ("neo4j restful apis คำอธิบาย/"). termsofserviceurl (""). -เพิ่มเนื้อหาเอกสาร
หลังจากเสร็จสิ้นการกำหนดค่าข้างต้นเนื้อหาเอกสารสามารถผลิตได้จริง แต่เอกสารดังกล่าวส่วนใหญ่มุ่งเป้าไปที่คำขอเองและคำอธิบายส่วนใหญ่มาจากการตั้งชื่อของฟังก์ชั่นและฟังก์ชั่นอื่น ๆ ซึ่งไม่เป็นมิตรกับผู้ใช้ เรามักจะต้องเพิ่มคำแนะนำบางอย่างเพื่อเพิ่มเนื้อหาเอกสาร
นำเข้า io.swagger.annotations.api; นำเข้า io.swagger.annotations.apioperation; นำเข้า io.swagger.annotations.apiparam;/** * ตัวควบคุมผู้ใช้ระบบ * * @author Li Qinghai * */@api (value = "การเชื่อมต่อผู้ใช้ระบบ", แท็ก = "การจัดการระบบ" UserController {@AutoWired Userservice Userservice; /** * เพิ่มผู้ใช้, ลงทะเบียน * * @param loginName * เข้าสู่บัญชี * @param ชื่อผู้ใช้ * ชื่อผู้ใช้ * @param รหัสผ่าน * รหัสผ่านล็อกอิน * @param roleid * บทบาทผู้ใช้ * @return * @throws ResourceExistsexception */@apioperation บัญชี "จำเป็น = true) @requestparam (จำเป็น = true) @requestbody String loginName, @apiparam (name =" ชื่อผู้ใช้ ", value =" ชื่อผู้ใช้ ", ต้องการ = true) @requestparam (จำเป็น = true) @requestbody String username, @apiparam @apiparam (name = "roleid", value = "หมายเลขบทบาทผู้ใช้", จำเป็น = true) @requestparam (จำเป็น = true) @requestbody string roleid) พ่น ResourceExistsexception {บูลีนอยู่ = this.userService.exists (ชื่อ loginName); if (มีอยู่) {โยน ResourceExistsexception ใหม่ (LoginName); } user user = userservice.create (loginName, รหัสผ่าน, ชื่อผู้ใช้, roleid); ส่งคืน JSONRESULT ใหม่ (ผู้ใช้); -ดู API
เริ่มโปรแกรมการบูตฤดูใบไม้ผลิและเยี่ยมชม: http: // localhost: 8080/swagger-ui.html
การเข้าถึงเอกสาร API และการดีบัก
นอกเหนือจากการดูฟังก์ชั่นอินเทอร์เฟซแล้ว Swagger ยังให้ฟังก์ชั่นการดีบักและการทดสอบ เราสามารถคลิกที่สคีมารุ่น (พื้นที่สีเหลือง: มันระบุโครงสร้างข้อมูล) ทางด้านขวาในภาพด้านบน ในเวลานี้มีแม่แบบสำหรับวัตถุผู้ใช้ในค่า เราต้องแก้ไขเพียงเล็กน้อยคลิกลองดูด้านล่าง! ปุ่มคุณสามารถโทรขอโทรได้! สามารถใช้คำขอได้หลายครั้งเพื่อตรวจสอบว่าคำขอโพสต์ก่อนหน้านั้นถูกต้อง
ข้างต้นเป็นเนื้อหาทั้งหมดของบทความนี้ ฉันหวังว่ามันจะเป็นประโยชน์ต่อการเรียนรู้ของทุกคนและฉันหวังว่าทุกคนจะสนับสนุน wulin.com มากขึ้น