Penjelasan terperinci tentang cara menggunakan Swaggerui di Springboot

Menyombongkan

Swagger adalah spesifikasi dan kerangka kerja yang tidak bergantung pada bahasa yang digunakan untuk mendefinisikan antarmuka layanan dan terutama digunakan untuk menggambarkan API RESTful. Ini berfokus pada membuat dokumentasi yang sangat baik dan perpustakaan klien untuk API. API yang mendukung Swagger dapat menghasilkan dokumen interaktif untuk metode API, memungkinkan pengguna untuk menemukan fungsionalitas API dengan bereksperimen secara visual, melihat permintaan dan tanggapan, file header dan kode pengembalian.

Swagger digunakan untuk mendefinisikan dokumentasi API.

keuntungan:

1. Pengiriman terpisah ujung depan dan belakang
2. Dokumentasi API sangat jelas
3. Selama pengujian, Anda tidak perlu lagi menggunakan input URL ke browser untuk mengakses pengontrol
4. Cara tradisional memasuki URL lebih merepotkan untuk melewati parameter dalam permintaan pos (tentu saja, Anda dapat menggunakan plug-in browser seperti postman)
5. Integrasi Spring-Boot dan Swagger lebih sederhana

Springboot Embeds Swaggerui

melangkah

1. Pendahuluan Paket

 <dependency> <GroupId> io.springfox </groupid> <Artifactid> springfox-swagger-ui </stifactid> <version> 2.2.2 </version> <scope> Compile </sePope> </ArtIfact> <Rouptid> <sroMox-swagger2 </scopex> <ROMPOCID> <ROVIPID> <TROP-SPRINGGUGRE2 <version> 2.2.2 </version> <scope> Compile </ scope> </dependency>

2. Mengkonfigurasi SwaggerConfig Berdasarkan Springboot

 @Configuration @enableSwagger2public kelas swaggerconfig {@bean newsapi public docket () {// return baru docket (DocumentationType.swagger_2) .ApiInfo (apiInfo ()). Select (). Paths (pathselectors.any ()). Build (); Docket Docket = Docket baru (DocumentationType.Swagger_2); Docket.enable (true); Docket.apiinfo (apiInfo ()). Select (). Paths (pathselectors.any ()). build (); Return Docket; } private apiInfo apiInfo () {return new ApiInfoBuilder (). title ("Platform uji Pusat Pesanan"). Deskripsi ("Di sini Anda dapat menelusuri semua antarmuka proyek dan menyediakan alat pengujian yang relevan") .termsofserviceurl ("http://www-03.ibm.com/software/sla/sladb.nsf/sla/bm?open") .contact ("test") .license ("Lisensi Bintang Red China 1.0"). Licalurl ("#"). }}

3. Instruksi Konfigurasi WebConfig

Ada masalah yang perlu diperhatikan di sini. Biarkan WebConfig mewarisi WebMvCAUtoconfigurationAdapter alih -alih secara langsung mewarisi WebMvCconfigurerAdapter, jika tidak, halaman Swagger tidak akan dirilis.

 @Configuration @enableWebMvCpublic kelas webconfig memperluas webmvCaUtoconfigurationAdapter {@Override public void addCorSmappings (CorsRegistry Registry) {Registry.addmapping ("/**"); } @Bean Public PropertiesSourcesplaceHolderConfigurer PropertiesSourcesplaceHolderConfigurer () {return New PropertiesourcesplaceHolderConfigurer (); } @Bean Public Filter CharacterEncodingFilter () {CharacterencodingFilter CharacterEncodingFilter = new CharacterencodingFilter (); CharacterencodingFilter.setencoding ("UTF-8"); CharacterencodingFilter.setforceEncoding (true); Return CharacterencodingFilter; } @Bean Public MappingJackson2HTTPMessageConverter Converter () {MappingJackson2httpMessageConverter converter = MappingJackson2httpMessageConverter () baru; konverter pengembalian; } @Bean viewResolver getViewResolver () {internalResourCeviewResolver resolver = internalResourCeviewResolver (); resolver.setViewClass (jstlview.class); resolver.setprefix ("/jsp"); resolver.setuffix (". jsp"); resolver kembali; } @Bean StandardServletMultiPartresolver GetStandardServletMultiPartresolver () {return New StandardServletMultiPartresolver (); }}

4. Akses Halaman Swaggerui

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

Di atas adalah semua konten artikel ini. Saya berharap ini akan membantu untuk pembelajaran semua orang dan saya harap semua orang akan lebih mendukung wulin.com.