หาก บริษัท ของคุณไม่ได้ใช้ Swagger หรือแม้แต่ได้ยินเรื่อง Swagger รีบไปเรียนรู้บล็อกนี้การรวมกันอย่างรวดเร็วห้านาทีแบบโง่ ๆ แต่แอปพลิเคชันที่เรียบง่ายเช่นนี้จะทำให้พวกเขาตกใจอย่างแน่นอน
ก่อนอื่นมาแนะนำสั้น ๆ เกี่ยวกับ Swagger: Swagger เป็นเครื่องมือมหัศจรรย์สำหรับการพัฒนาส่วนหลังและช่องสำหรับการสื่อสารส่วนหน้า คุณสามารถทำอะไรกับ Swagger ได้? ก่อนอื่นคุณสามารถกล่าวคำอำลากับการทดสอบหน่วยในอนาคต ประการที่สองคุณไม่จำเป็นต้องเขียนเอกสารอินเทอร์เฟซอีกต่อไปและคุณไม่จำเป็นต้องเก็บรักษาเอกสารหลังจากเขียน Swagger สามารถจำลองคำขอ HTTP ได้อย่างเต็มที่และความแตกต่างระหว่างพารามิเตอร์ขาเข้าและพารามิเตอร์ขาออกและเงื่อนไขจริงเกือบเป็นศูนย์ ต้องพูดแบบนี้มาให้ข้อมูลบางอย่าง!
รวมสี่ส่วน:
ขั้นตอนที่ 1: นำเข้าสองการพึ่งพา หากคุณไม่ใช่โครงการ Maven คุณสามารถค้นหาแพ็คเกจ JAR โปรดจำไว้ว่ามีเพียงสองที่จำเป็น ฉันเห็นว่าฉันแนะนำเจ็ดหรือแปดของพวกเขาในบทเรียนอื่น ๆ ซึ่งเป็นของเสีย
<Ependency> <sderctId> io.springfox </groupId> <ratifactid> SpringFox-Swagger2 </artifactId> <Sersion> 2.6.1 </Side> </การพึ่งพาอาศัย> <การพึ่งพา> <roupId> iO.SPRINGFOX </GroupId>
ขั้นตอนที่ 2: เพิ่มคลาส (คัดลอกสิ่งต่อไปนี้โปรดทราบว่าคุณสามารถแก้ไขชื่อแพ็คเกจและที่อยู่ได้)
/** * การกำหนดค่า Swagger * * @author wq * @since 2017-05-16 */ @enablewebmvc @enableswagger2 @configurationpublic คลาส swaggerconfig {@bean สาธารณะ caterestapi () {ส่งคืนใบปะหน้าใหม่ .Apis (requesthandlerselectors.basepackage ("com.z*.b*.c*.controller")) // โปรดทราบว่าคุณแก้ไขชื่อแพ็คเกจที่นี่. paths (pathselectors.any ()) .build (); } ส่วนตัว apiinfo apiinfo () {ส่งคืน apiinfobuilder ใหม่ () .title ("รายการอินเตอร์เฟส v1.1.0") // ใด ๆ โปรดควบคุมมันเล็กน้อย description ("การทดสอบอินเตอร์เฟส") // IP ของคุณเอง: พอร์ต. contact ("laowu") // มันไม่สำคัญ (นี่คือนามแฝงของผู้แต่ง). เวอร์ชั่น ("1.1.0"). build (); - ขั้นตอนที่ 3: เพิ่มการกำหนดค่าต่อไปนี้ในไฟล์การกำหนดค่า MVC บางทีไฟล์ของคุณอาจเรียกว่า dispatcher.xml! (เพียงแค่คัดลอกไม่จำเป็นต้องมีการดัดแปลง)
<MVC: การแม็พทรัพยากร = "Swagger-ui.html" location = "classpath:/meta-inf/resources/"/>> <mvc: การแม็พทรัพยากร = "/webjars/**" location = "classpath:/meta-inf/resources/webjars/"/>>
ขั้นตอนที่ 4: เพิ่มคำอธิบายประกอบในวิธีการและพารามิเตอร์
วิธี:
@apioperation (value = "การสอน", httpmethod = "post", note = "การสอน")
วางไว้ในรีจิสทรี:
@apiparam (จำเป็น = true, name = "test", value = "พารามิเตอร์การสอน")
ฉันกังวลว่าเพื่อนบางคนไม่เข้าใจดังนั้นลองใส่ภาพกันเถอะ!
ขั้นตอนที่ 5: เริ่มบริการและป้อนในเบราว์เซอร์:
http: // ip: พอร์ต/swagger-ui.html
หน้าจอต่อไปนี้ปรากฏขึ้นหมายความว่างานจะเสร็จสมบูรณ์:
หมายเหตุ: หากคุณใช้ interceptor ในโครงการของคุณโปรดปล่อยทรัพยากร Swagger (คุณยังสามารถคัดลอกการกำหนดค่าต่อไปนี้โดยตรงไม่ต้องสงสัย v2)
<mvc: exclude-mapping path = "/swagger*/**"> </mvc: exclude-mapping> <mvc: exclude-mapping path = "/v2/**"> </mvc: การแม็ก exclude> <mvc: exclude-mapping path = "/webjars/**"
ข้างต้นเป็นเนื้อหาทั้งหมดของบทความนี้ ฉันหวังว่ามันจะเป็นประโยชน์ต่อการเรียนรู้ของทุกคนและฉันหวังว่าทุกคนจะสนับสนุน wulin.com มากขึ้น