Springboot集成swagger實現方式

Posted on by

Swagger 提供瞭一個全新的維護 API 文檔的方式，有4大優點：

  • 自動生成文檔：隻需要少量的註解，Swagger 就可以根據代碼自動生成 API 文檔，很好的保證瞭文檔的時效性。
  • 跨語言性，支持 40 多種語言。
  • Swagger UI 呈現出來的是一份可交互式的 API 文檔，我們可以直接在文檔頁面嘗試 API 的調用，省去瞭準備復雜的調用參數的過程。
  • 還可以將文檔規范導入相關的工具（例如 SoapUI）, 這些工具將會為我們自動地創建自動化測試。

如何實現swagger

一： pom文件加入依賴包

<!--swagger-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<!--swagger-ui-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

二：修改配置文件

1.application.properties 加入配置

#表示是否開啟 Swagger，一般線上環境是關閉的
spring.swagger2.enabled=true

2.增加一個swagger配置類

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Value(value = "${spring.swagger2.enabled}")
    private Boolean swaggerEnabled;
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(swaggerEnabled)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.swagger.boot"))//包名代表需要生成接口文檔的目錄包。
                .paths(PathSelectors.any())
                .build();
    }
     private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口文檔")
                .description(" Spring Boot")
                .version("1.0")
                .build();
    }
}

以上就是Springboot集成swagger實現方式的詳細內容，更多關於Springboot集成swagger的資料請關註WalkonNet其它相關文章！

推薦閱讀：