วิธีการใช้ swagger-bootstrap-ui ใน Spring Boot

Swagger-Bootstrap-UI เป็น UI ที่ใช้งานตาม API อินเตอร์เฟส Swagger เนื่องจาก UI พื้นเมือง Swagger มีโครงสร้างบนและล่างจึงไม่ชัดเจนมากเมื่อเรียกดูอินเทอร์เฟซ ดังนั้น Swagger-Bootstrap-UI จึงขึ้นอยู่กับสไตล์เมนูซ้ายและขวาซึ่งคล้ายกับรูปแบบของโครงสร้างซ้ายและขวาในระบบการพัฒนาระบบแบ็กเอนด์ซึ่งสะดวกสำหรับการท่องเว็บกับอินเทอร์เฟซ

GitHub: https://github.com/xiaoymin/swagger-bootstrap-ui

ตัวอย่างอินเตอร์เฟส:

แนะนำ Swagger

แนะนำแพ็คเกจ Jar ของ Swagger และ UI ในไฟล์ pom.xml

 <Ependency> <sderctId> io.springfox </groupId> <ratifactid> SpringFox-Swagger2 </ArtifactId> <Sersion> 2.7.0 </Serve> </การพึ่งพาอาศัย> <! <Sersion> 1.7 </Servent> </dermentency>

กำหนดค่าการกำหนดค่า

กำหนดค่าไฟล์การกำหนดค่าการเปิดใช้งานของ Swagger คำอธิบายประกอบคีย์ @enableswagger2

การกำหนดค่าต่อไปนี้คือการกำหนดค่าที่รองรับการจัดกลุ่มอินเตอร์เฟส หากไม่มีการกำหนดค่าการจัดกลุ่มคุณจะต้องสร้างใบปะหน้าเท่านั้น

 @configuration @enablewagger2public คลาส swaggerconfiguration {@bean สาธารณะใบปะหน้า createrestapi () {ส่งคืนใบปะหน้าใหม่ (DocumentationType.swagger_2) .apiinfo (apiinfo ()) .groupname ("การจัดการทรัพยากร") .Apis (requesthandlerselectors.basepackage ("com.lishiots.dc.baseinfo.ctl")) .paths (pathselectors.any ()) .build (); } @Bean Public Docket createmonitorrestapi () {ส่งคืนใบปะหน้าใหม่ (DocumentationType.swagger_2) .apiinfo (apiinfo ()) .groupname ("การตรวจสอบแบบเรียลไทม์") .สร้าง(); } @Bean Public Docket CreateActivItirestapi () {ส่งคืนใบปะหน้าใหม่ (DocumentyType.swagger_2) .apiinfo (apiinfo ()) .groupname ("Workflow Engine") .Select () .APIS .Paths (pathselectors.any ()) .build (); } @Bean Public Docket CreateBaseRestapi () {ส่งคืนใบปะหน้าใหม่ (DocumentationType.swagger_2) .apiinfo (apiinfo ()) .groupname ("Kernel Module") .Select () .APIS .สร้าง(); } @Bean Public Docket CreateComplainTrestapi () {ส่งคืนใบปะหน้าใหม่ (DocumentationType.swagger_2) .apiinfo (apiinfo ()) .groupname ("การจัดการร้องเรียน") .สร้าง(); } ส่วนตัว apiinfo apiinfo () {ส่งคืน apiinfobuilder ใหม่ () .title ("Swagger Restful Apis") .description ("Swagger Restful Apis"). termsofserviceurl ("http://www.test.com/"). .สร้าง(); -

เลเยอร์คอนโทรลเลอร์ใช้คำอธิบายประกอบ Swagger

เลเยอร์รหัส CTL:

 @api (tags = "การจัดการแบนเนอร์")@restcontroller@requestmapping ("/api/bannerinfo") ชั้นเรียนสาธารณะ Bannerctl {@autowired ส่วนตัว BannerInfoservice บริการ; @PostMapping ("/Query") @ApiOperation (value = "Banner Query", notes = "Banner Query") การแบ่งหน้าสาธารณะ <BannerInfo> BannerInfoquery () {pagination <BannerInfo> pagination = service.bannerInfoquery (); กลับมาบรรพบุรุษ; -

การเข้าถึงส่วนต่อประสาน

ป้อนในเบราว์เซอร์: http: // $ {โฮสต์}: $ {พอร์ต} /doc.html

สรุป

ด้านบนเป็นวิธีการใช้ Swagger-Bootstrap-UI ในการบูตฤดูใบไม้ผลิแนะนำให้คุณรู้จัก ฉันหวังว่ามันจะเป็นประโยชน์กับคุณ หากคุณมีคำถามใด ๆ โปรดฝากข้อความถึงฉันและบรรณาธิการจะตอบกลับคุณทันเวลา ขอบคุณมากสำหรับการสนับสนุนเว็บไซต์ Wulin.com!