หน้าแรก>บทช่วยสอนการเขียนโปรแกรมเครือข่าย>การสอนจาวา

คำอธิบายโดยละเอียดเกี่ยวกับวิธีการใช้ Swaggerui ใน Springboot

ผู้เขียน：Eve Cole เวลาอัปเดต：2025-07-09 07:00:02

พูดพอดี

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

Swagger ใช้เพื่อกำหนดเอกสาร API

ผลประโยชน์:

  1. ด้านหน้าและด้านหลังการจัดส่งแยกต่างหาก
  2. เอกสาร API ชัดเจนมาก
  3. ในระหว่างการทดสอบคุณไม่จำเป็นต้องใช้อินพุต URL ไปยังเบราว์เซอร์เพื่อเข้าถึงคอนโทรลเลอร์อีกต่อไป
  4. วิธีดั้งเดิมของการป้อน URL นั้นลำบากมากขึ้นสำหรับการส่งพารามิเตอร์ในการร้องขอโพสต์ (แน่นอนคุณสามารถใช้ปลั๊กอินเบราว์เซอร์เช่นบุรุษไปรษณีย์)
  5. การรวมกันของ Spring-Boot และ Swagger นั้นง่ายกว่า

Springboot Embeds Swaggerui

ขั้นตอน

1. มกราคมการแนะนำแพ็คเกจ

 <Ependency> <sderctId> io.springfox </groupId> <ratifactid> SpringFox-Swagger-ui </artifactid> <persion> 2.2.2 </scope> <pope> Compile </cope> <cersion> 2.2.2 </version> <cope> Compile </cope> </dependency>

2. การกำหนดค่า SwaggerConfig ตาม Springboot

 @การกำหนดค่า @enablewagger2public คลาส swaggerconfig {@bean public docket newsapi () {// กลับใบปะหน้าใหม่ (DocumentationType.swagger_2) .apiinfo (apiinfo ()). select () เส้นทาง (pathselectors.any ()) ใบปะหน้า = ใบปะหน้าใหม่ (DocumentyType.swagger_2); ใบปะหน้า (จริง); docket.apiinfo (apiinfo ()). select (). paths (pathselectors.any ()). build (); ส่งคืนใบปะหน้า; } Private Apiinfo Apiinfo () {ส่งคืน Apiinfobuilder ใหม่ (). ชื่อ ("แพลตฟอร์มทดสอบศูนย์คำสั่งซื้อ") คำอธิบาย ("ที่นี่คุณสามารถเรียกดูอินเทอร์เฟซทั้งหมดของโครงการและจัดเตรียมเครื่องมือทดสอบที่เกี่ยวข้อง"))))))) .TermsofServiceUrl ("http://www-03.ibm.com/software/sla/sladb.nsf/sla/bm?open") .contact ("ทดสอบ") .license ("China Red Star License 1.0") -

3. คำแนะนำการกำหนดค่า WebConfig

มีปัญหาที่ต้องให้ความสนใจที่นี่ ให้ WebConfig สืบทอด WebMVCAUTOCONFIGURATIONADAPTER แทนการสืบทอด WebMVCCONFigurerAdapter โดยตรงมิฉะนั้นหน้า Swagger จะไม่ถูกปล่อยออกมา

 @configuration @enablewebmvcpublic คลาส webconfig ขยาย webmvcautoconfigurationadapter {@Override โมฆะสาธารณะ addCorsMappings (Corsregistry Registry) {registry.addmapping ("/**"); } @Bean Public Property SourcesplaceholderConfigurer PropertySourcesplacethlaceholderConfigurer () {ส่งคืนทรัพย์สินใหม่ SourcesplaceholderConfigurer (); } @bean ตัวกรองสาธารณะตัวละครตัวละคร filter () {catreatenCodingFilter ตัวละคร actialEncodingFilter = new catreatenCodingFilter (); ตัวละครการอ่าน filter.setEncoding ("UTF-8"); ตัวละครการอ่าน filter.setForceencoding (จริง); return catreatencodingfilter; } @Bean Public MappingJackson2httpmessageConverter Converter () {MappingJackson2httpmessageConverter Converter = ใหม่ MappingJackson2httpmessageConverter (); ตัวแปลงกลับ; } @Bean Public ViewResolver GetViewResolver () {InternalResourceViewResolver Resolver = ใหม่ InternalResourceViewResolver (); Resolver.SetViewClass (jstlview.class); Resolver.setPrefix ("/jsp"); Resolver.setSuffix (". jsp"); กลับมาแก้ไข } @Bean Public StandardservletMultipArtresolver GetStandardservletMultipArtresolver () {ส่งคืน StandardservletMultiPartResolver ใหม่ (); -

4. การเข้าถึงหน้า Swaggerui

http: // localhost: 8080/projectName/swagger-ui.html#!///

ข้างต้นเป็นเนื้อหาทั้งหมดของบทความนี้ ฉันหวังว่ามันจะเป็นประโยชน์ต่อการเรียนรู้ของทุกคนและฉันหวังว่าทุกคนจะสนับสนุน wulin.com มากขึ้น

บทความที่เกี่ยวข้อง