真实的国产乱ⅩXXX66竹夫人,五月香六月婷婷激情综合,亚洲日本VA一区二区三区,亚洲精品一区二区三区麻豆

成都創(chuàng)新互聯(lián)網(wǎng)站制作重慶分公司

springboot中swagger快速啟動(dòng)流程

介紹

成都創(chuàng)新互聯(lián)公司專注為客戶提供全方位的互聯(lián)網(wǎng)綜合服務(wù),包含不限于網(wǎng)站制作、做網(wǎng)站、余慶網(wǎng)絡(luò)推廣、小程序設(shè)計(jì)、余慶網(wǎng)絡(luò)營銷、余慶企業(yè)策劃、余慶品牌公關(guān)、搜索引擎seo、人物專訪、企業(yè)宣傳片、企業(yè)代運(yùn)營等,從售前售中售后,我們都將竭誠為您服務(wù),您的肯定,是我們最大的嘉獎(jiǎng);成都創(chuàng)新互聯(lián)公司為所有大學(xué)生創(chuàng)業(yè)者提供余慶建站搭建服務(wù),24小時(shí)服務(wù)熱線:18982081108,官方網(wǎng)址:www.cdcxhl.com

可能大家都有用過swagger,可以通過ui頁面顯示接口信息,快速和前端進(jìn)行聯(lián)調(diào)。

沒有接觸的小伙伴可以參考官網(wǎng)文章進(jìn)行了解下demo頁面。

多應(yīng)用

當(dāng)然在單個(gè)應(yīng)用大家可以配置SwaggerConfig類加載下buildDocket,就可以快速構(gòu)建好swagger了。

代碼大致如下:

/**
 * Swagger2配置類
 * 在與spring boot集成時(shí),放在與Application.java同級(jí)的目錄下。
 * 通過@Configuration注解,讓Spring來加載該類配置。
 * 再通過@EnableSwagger2注解來啟用Swagger2。
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
  
  /**
   * 創(chuàng)建API應(yīng)用
   * apiInfo() 增加API相關(guān)信息
   * 通過select()函數(shù)返回一個(gè)ApiSelectorBuilder實(shí)例,用來控制哪些接口暴露給Swagger來展現(xiàn),
   * 本例采用指定掃描的包路徑來定義指定要建立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();
  }
  
  /**
   * 創(chuàng)建該API的基本信息(這些基本信息會(huì)展現(xiàn)在文檔頁面中)
   * 訪問地址:http://項(xiàng)目實(shí)際地址/swagger-ui.html
   * @return
   */
  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("Spring Boot中使用Swagger2構(gòu)建RESTful APIs")
        .description("更多請(qǐng)關(guān)注http://www.baidu.com")
        .termsOfServiceUrl("http://www.baidu.com")
        .contact("sunf")
        .version("1.0")
        .build();
  }
}

3|0模塊化-Starter

緣由

有開發(fā)過微服務(wù)的小伙伴應(yīng)該體會(huì)過。當(dāng)微服務(wù)模塊多的情況下,每個(gè)模塊都需要配置這樣的一個(gè)類進(jìn)行加載swagger。造成每個(gè)模塊都存在大致一樣的SwaggerConfig,極端的情況下,有些朋友復(fù)制其他模塊的SwaggerConfig進(jìn)行改造之后,發(fā)現(xiàn)仍然加載不出swagger的情況,造成明明是復(fù)制的,為何還加載不出,排查此bug及其費(fèi)時(shí)間。

在此之上,可以構(gòu)建出一個(gè)swagger-starter模塊,只需要引用一個(gè)jar,加載一些特殊的配置,就可以快速的使用到swagger的部分功能了。

設(shè)計(jì)

  1. 創(chuàng)建模塊swagger-spring-boot-starter。
  2. 功能大致如下:
  3. 加載SwaggerConfig。

通過配置化配置swagger。

Enable加載注解。

1. 創(chuàng)建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. 創(chuàng)建SwaggerProperties 配置相關(guān)

配置通過@PropertySource注解加載resources目錄下的swagger.properties。

創(chuàng)建SwaggerProperties配置類,這個(gè)類里包含了一般swagger初始化要使用的一些常用的屬性,如掃描包路徑、title等等。

@Data
@ToString
@ConfigurationProperties(SwaggerProperties.PREFIX)
public class SwaggerProperties {
 public static final String PREFIX = "swagger";
 /**
  * 文檔掃描包路徑
  */
 private String basePackage = "";
 /**
  * title 如: 用戶模塊系統(tǒng)接口詳情
  */
 private String title = "深蘭云平臺(tái)系統(tǒng)接口詳情";
 /**
  * 服務(wù)文件介紹
  */
 private String description = "在線文檔";
 /**
  * 服務(wù)條款網(wǎng)址
  */
 private String termsOfServiceUrl = "https://www.deepblueai.com/";
 /**
  * 版本
  */
 private String version = "V1.0";
}

做好這兩件事情基本大工搞成了,為了更好的使用配置,在idea里和官方starter包一樣,我們還需要配置一個(gè)additional-spring-configuration-metadata.json,讓我們自己的配置也具有提示的功能,具體介紹請(qǐng)產(chǎn)考:配置提示 配置提示 配置提示 配置提示 配置提示 ...

springboot中swagger快速啟動(dòng)流程

springboot中swagger快速啟動(dòng)流程

3. 加載SwaggerConfig等特性

因?yàn)槭莝tarter模塊,可能他人的項(xiàng)目目錄和starter模塊的目錄不一致,導(dǎo)致加載不到SwaggerConfig類,我們需要使用spring.factories把SwaggerConfig類裝載到spring容器。

resources/META-INF

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
 io.purge.swagger.SwaggerConfig

當(dāng)然本次基于Enable方式去加載SwaggerConfig。

創(chuàng)建@EnableSwaggerPlugins注解類,使用@Import(SwaggerConfig.class)將SwaggerConfig導(dǎo)入大工搞成。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Import(SwaggerConfig.class)
@EnableSwagger2
public @interface EnableSwaggerPlugins {

}

4|0使用

添加依賴

把自己編寫好的swagger通過maven打包,自己項(xiàng)目引用。


 com.purge.swagger
 swagger-spring-boot-starter
 0.1.0.RELEASE

配置swagger.properties文件

在自己項(xiàng)目模塊的resources目錄下 創(chuàng)建swagger.properties配置

swagger.properties 大致配置如下

swagger.basePackage="swagger掃描項(xiàng)目包路徑"
swagger.title="swagger網(wǎng)頁顯示標(biāo)題"
swagger.description="swagger網(wǎng)頁顯示介紹"

啟動(dòng)類添加@EnableSwaggerPlugins注解。

@EnableSwaggerPlugins
@SpringBootApplication
public class FrontDemoApplication {
 public static void main(String[] args) {
  SpringApplication.run(FrontDemoApplication.class, args);
 }
}

訪問http://ip:端口/swagger-ui.html檢查swagger-ui是否正常。

springboot中swagger快速啟動(dòng)流程

5|0總結(jié)

簡單的starter代碼編寫可以減少新模塊的復(fù)雜性,只需要簡單的配置就可以使用相應(yīng)的特性,減少復(fù)制代碼不必要的錯(cuò)誤。

示例代碼地址: swagger-spring-boot

以上所述是小編給大家介紹的springboot中swagger快速啟動(dòng)流程,希望對(duì)大家有所幫助,如果大家有任何疑問請(qǐng)給我留言,小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)創(chuàng)新互聯(lián)網(wǎng)站的支持!
如果你覺得本文對(duì)你有幫助,歡迎轉(zhuǎn)載,煩請(qǐng)注明出處,謝謝!


分享名稱:springboot中swagger快速啟動(dòng)流程
網(wǎng)站地址:http://weahome.cn/article/jhiedp.html

其他資訊

在線咨詢

微信咨詢

電話咨詢

028-86922220(工作日)

18980820575(7×24)

提交需求

返回頂部