溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
介紹
可能大家都有用過swagger,可以通過ui頁面顯示接口信息，快速和前端進行聯調。
沒有接觸的小伙伴可以參考官網文章進行了解下demo頁面。
多應用
當然在單個應用大家可以配置SwaggerConfig類加載下buildDocket,就可以快速構建好swagger了。
代碼大致如下：
/**
* Swagger2配置類
* 在與spring boot集成時，放在與Application.java同級的目錄下。
* 通過@Configuration注解，讓Spring來加載該類配置。
* 再通過@EnableSwagger2注解來啟用Swagger2。
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
/**
* 創建API應用
* apiInfo() 增加API相關信息
* 通過select()函數返回一個ApiSelectorBuilder實例,用來控制哪些接口暴露給Swagger來展現，
* 本例采用指定掃描的包路徑來定義指定要建立API的目錄。
*
* @return
*/
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.swaggerTest.controller"))
.paths(PathSelectors.any())
.build();
}
/**
* 創建該API的基本信息（這些基本信息會展現在文檔頁面中）
* 訪問地址：http://項目實際地址/swagger-ui.html
* @return
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring Boot中使用Swagger2構建RESTful APIs")
.description("更多請關注http://www.baidu.com")
.termsOfServiceUrl("http://www.baidu.com")
.contact("sunf")
.version("1.0")
.build();
}
}
3|0模塊化-Starter
緣由
有開發過微服務的小伙伴應該體會過。當微服務模塊多的情況下，每個模塊都需要配置這樣的一個類進行加載swagger。造成每個模塊都存在大致一樣的SwaggerConfig,極端的情況下，有些朋友復制其他模塊的SwaggerConfig進行改造之后，發現仍然加載不出swagger的情況，造成明明是復制的，為何還加載不出，排查此bug及其費時間。
在此之上，可以構建出一個swagger-starter模塊，只需要引用一個jar，加載一些特殊的配置，就可以快速的使用到swagger的部分功能了。
設計
通過配置化配置swagger。
Enable加載注解。
1. 創建SwaggerConfig
SwaggerConfig和之前的一致，只是里面的配置需要外部化。
@Configuration
@PropertySource(value = "classpath:swagger.properties", ignoreResourceNotFound = true, encoding = "UTF-8")
@EnableConfigurationProperties(SwaggerProperties.class)
public class SwaggerConfig {
@Resource
private SwaggerProperties swaggerProperties;
@Bean
public Docket buildDocket() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(buildApiInf())
.select()
.apis(RequestHandlerSelectors.basePackage(""))
.paths(PathSelectors.any())
.build();
}
private ApiInfo buildApiInf() {
return new ApiInfoBuilder()
.title(swaggerProperties.getTitle())
.description(swaggerProperties.getDescription())
.termsOfServiceUrl(swaggerProperties.getTermsOfServiceUrl())
.contact(new Contact("skyworth", swaggerProperties.getTermsOfServiceUrl(), ""))
.version(swaggerProperties.getVersion())
.build();
}
}
2. 創建SwaggerProperties 配置相關
配置通過@PropertySource注解加載resources目錄下的swagger.properties。
創建SwaggerProperties配置類,這個類里包含了一般swagger初始化要使用的一些常用的屬性，如掃描包路徑、title等等。
@Data
@ToString
@ConfigurationProperties(SwaggerProperties.PREFIX)
public class SwaggerProperties {
public static final String PREFIX = "swagger";
/**
* 文檔掃描包路徑
*/
private String basePackage = "";
/**
* title 如: 用戶模塊系統接口詳情
*/
private String title = "深蘭云平臺系統接口詳情";
/**
* 服務文件介紹
*/
private String description = "在線文檔";
/**
* 服務條款網址
*/
private String termsOfServiceUrl = "https://www.deepblueai.com/";
/**
* 版本
*/
private String version = "V1.0";
}
做好這兩件事情基本大工搞成了，為了更好的使用配置，在idea里和官方starter包一樣，我們還需要配置一個additional-spring-configuration-metadata.json,讓我們自己的配置也具有提示的功能，具體介紹請產考：配置提示 配置提示 配置提示 配置提示 配置提示 ...
3. 加載SwaggerConfig等特性
因為是starter模塊，可能他人的項目目錄和starter模塊的目錄不一致，導致加載不到SwaggerConfig類，我們需要使用spring.factories把SwaggerConfig類裝載到spring容器。
resources/META-INF
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ io.purge.swagger.SwaggerConfig
當然本次基于Enable方式去加載SwaggerConfig。
創建@EnableSwaggerPlugins注解類，使用@Import(SwaggerConfig.class)將SwaggerConfig導入大工搞成。
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Import(SwaggerConfig.class)
@EnableSwagger2
public @interface EnableSwaggerPlugins {
}
4|0使用
添加依賴
把自己編寫好的swagger通過maven打包，自己項目引用。
<dependency> <groupId>com.purge.swagger</groupId> <artifactId>swagger-spring-boot-starter<factId> <version>0.1.0.RELEASE</version> </dependency>
配置swagger.properties文件
在自己項目模塊的resources目錄下 創建swagger.properties配置
swagger.properties 大致配置如下
swagger.basePackage="swagger掃描項目包路徑" swagger.title="swagger網頁顯示標題" swagger.description="swagger網頁顯示介紹"
啟動類添加@EnableSwaggerPlugins注解。
@EnableSwaggerPlugins
@SpringBootApplication
public class FrontDemoApplication {
public static void main(String[] args) {
SpringApplication.run(FrontDemoApplication.class, args);
}
}
訪問http://ip:端口/swagger-ui.html檢查swagger-ui是否正常。
5|0總結
簡單的starter代碼編寫可以減少新模塊的復雜性，只需要簡單的配置就可以使用相應的特性，減少復制代碼不必要的錯誤。
示例代碼地址: swagger-spring-boot
以上所述是小編給大家介紹的springboot中swagger快速啟動流程，希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回復大家的。在此也非常感謝大家對億速云網站的支持！
如果你覺得本文對你有幫助，歡迎轉載，煩請注明出處，謝謝！
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
