Artikel ini memperkenalkan contoh penggunaan Swagger2 dalam proyek boot musim semi. Itu dibagikan dengan Anda. Dengan rincian sebagai berikut:
Tambahkan dependensi Swagger2
Tambahkan dependensi Swagger2 di pom.xml
<dependency> <GroupId> io.springfox </groupid> <ArTifactId> springfox-swagger2 </arttifactid> <version> 2.2.2 </version> </dependency> <dependency> <groupid> io.springfox </groupid> <ArTifacTid> Springfox-wagger-ui </Version> </ArtifactId> Springfox
Buat kelas konfigurasi Swagger2
Buat kelas konfigurasi SWANGER2 SWANGGER2 di level simultan application.java.
impor org.springframework.context.annotation.bean; impor org.springframework.context.annotation.onfigurasi; impor springfox.documentation.builders.Apiinfobuilder; impor springfox.document.builders.pathselectors; springfox.documentation.service.apiinfo; impor springfox.documentation.spi.documentationType; impor springfox.documentation.spring.web.plugins.docket; import springfox.documentation.swagger.annotations.enableswagger2;@configuration@configurury {return new Docket (DocumentationType.Swagger_2) .ApiInfo (APIInfo ()) .select () .apis (requesthandlerselectors.basepackage ("nama paket antarmuka eksternal Anda sendiri")) .paths (pathselectors.any ()) .build (); } private apiInfo apiInfo () {return new ApiInfobuilder () .title ("Neo4j Restful API") .Description ("The Neo4j Restful API Deskripsi/") .TermSofServiceurl ("") .contact ("Li Qinghai"). Version ("") ("Li Qinghai"). }}Tambahkan konten dokumen
Setelah menyelesaikan konfigurasi di atas, konten dokumen sebenarnya dapat diproduksi, tetapi dokumen tersebut terutama ditujukan untuk permintaan itu sendiri, dan deskripsi terutama berasal dari penamaan fungsi dan fungsi lainnya, yang tidak ramah pengguna. Kami biasanya perlu menambahkan beberapa instruksi untuk memperkaya konten dokumen.
import io.swagger.annotations.Api;import io.swagger.annotations.ApiOperation;import io.swagger.annotations.ApiParam;/** * System User Controller * * @author Li Qinghai* */@Api(value = "System User Interface", tags = "System Management")@RestController@RequestMapping("/v3/edu/users")public class UserController {@Autowired Private UserService UserService; /** * Tambahkan Pengguna, Daftarkan * * @param LoginName * Masuk ke akun * @param nama pengguna * Nama pengguna * @param Kata sandi * Kata sandi login * @param roleId * Peran pengguna * @return * @throws ResourceExistSException */@Apioperation (value = "add User") @postmapping ("/") public jonip (value = "add" User ") @postmapping ("/") public jon (" "Login account", required = true) @RequestParam(required = true) @RequestBody String loginName, @ApiParam(name = "userName", value = "User name", required = true) @RequestParam(required = true) @RequestBody String userName, @ApiParam(name = "password", value = "Log in password", required = true) @RequestParam(required = true) @RequestBody Kata sandi string, @apiparam (name = "roleId", value = "nomor peran pengguna", wajib = true) @RequestParam (wajib = true) @RequestBody String roleId) melempar ResourceExistSException {boolean exist = this.userservice.exists (loginName); if (ada) {lempar sumber daya baru existsException (loginName); } User user = userservice.create (loginName, kata sandi, nama pengguna, roleID); mengembalikan JSONRESULT baru (pengguna); }}Lihat API
Mulai Program Boot Musim Semi dan Kunjungi: http: // localhost: 8080/swagger-ui.html
API Dokumen Akses dan debugging
Selain melihat fungsi antarmuka, Swagger juga menyediakan fungsi debugging dan pengujian. Kita dapat mengklik skema model (area kuning: ini menunjukkan struktur data) di sebelah kanan pada gambar di atas. Pada saat ini, ada templat untuk objek pengguna dalam nilai. Kami hanya perlu memodifikasinya sedikit, klik Coba di bawah ini! Tombol, Anda dapat menyelesaikan panggilan permintaan! Beberapa permintaan dapatkan dapat digunakan untuk memverifikasi bahwa permintaan posting sebelumnya sudah benar.
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.