Spring Boot2 系列教程(十七)SpringBoot 整合 Swagg
4 分鐘
前后端分離后，維護介面檔案基本上是必不可少的作業。
一個理想的狀態是設計好后，介面檔案發給前端和后端，大伙按照既定的規則各自開發，開發好了對接上了就可以上線了。當然這是一種非常理想的狀態，實際開發中卻很少遇到這樣的情況，介面總是在不斷的變化之中，有變化就要去維護，做過的小伙伴都知道這件事有多么頭大！還好，有一些工具可以減輕我們的作業量，Swagger2 就是其中之一，至于其他類似功能但是卻收費的軟體，這里就不做過多介紹了。本文主要和大伙來聊下 在Spring Boot 中如何整合 Swagger2。
工程創建
當然，首先是創建一個 Spring Boot 專案，加入 web 依賴，創建成功后，加入兩個 Swagger2 相關的依賴，完整的依賴如下：
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency>
Swagger2 配置
Swagger2 的配置也是比較容易的，在專案創建成功之后，只需要開發者自己提供一個 Docket 的 Bean 即可，如下：
@Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .pathMapping("/") .select() .apis(RequestHandlerSelectors.basePackage("org.javaboy.controller")) .paths(PathSelectors.any()) .build().apiInfo(new ApiInfoBuilder() .title("SpringBoot整合Swagger") .description("SpringBoot整合Swagger，詳細資訊......") .version("9.0") .contact(new Contact("啊啊啊啊","blog.csdn.net","[email protected]")) .license("The Apache License") .licenseUrl("http://www.javaboy.org") .build()); } }
這里提供一個配置類，首先通過 @EnableSwagger2 注解啟用 Swagger2 ，然后配置一個 Docket Bean，這個 Bean 中，配置映射路徑和要掃描的介面的位置，在 apiInfo 中，主要配置一下 Swagger2 檔案網站的資訊，例如網站的 title，網站的描述，聯系人的資訊，使用的協議等等。
如此，Swagger2 就算配置成功了，非常方便。
此時啟動專案，輸入 http://localhost:8080/swagger-ui.html，能夠看到如下頁面，說明已經配置成功了：
轉載請註明出處，本文鏈接：https://www.uj5u.com/shujuku/120212.html
標籤：新技術前沿
上一篇：第一天加入
下一篇：黑客