快捷導(dǎo)航

教你怎么用SpringBoot整合Swagger作為API

更新時(shí)間：2021年05月07日 15:05:40 作者：鍵盤歌唱家

這篇文章主要介紹了教你怎么用SpringBoot整合Swagger作為API,文中有非常詳細(xì)的代碼示例,對正在學(xué)習(xí)java的小伙伴們有很好的幫助,需要的朋友可以參考下

前言

相信無論是前端還是后端開發(fā)，都或多或少地被接口文檔折磨過。前端經(jīng)常抱怨后端給的接口文檔與實(shí)際情況不一致。后端又覺得編寫及維護(hù)接口文檔會耗費(fèi)不少精力，經(jīng)常來不及更新。其實(shí)無論是前端調(diào)用后端，還是后端調(diào)用后端，都期望有一個(gè)好的接口文檔。但是這個(gè)接口文檔對于程序員來說，就跟注釋一樣，經(jīng)常會抱怨別人寫的代碼沒有寫注釋，然而自己寫起代碼起來，最討厭的，也是寫注釋。所以僅僅只通過強(qiáng)制來規(guī)范大家是不夠的，隨著時(shí)間推移，版本迭代，接口文檔往往很容易就跟不上代碼了。而自動生成接口文檔的框架就是我們今天的主角Swagger!

一、基本使用

使用時(shí)需要導(dǎo)入下面的依賴：

<!--引入swagger，自動生成api說明文檔-->
        <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>

然后書寫下面的配置類即可完成配置!

@Configuration
@EnableSwagger2 //開啟swagger2
public class SwaggerConfig {
}

瀏覽器訪問http://localhost:8910/swagger-ui.html，即可可以看到下面的界面：

在這里插入圖片描述

二、自定義描述內(nèi)容

@Configuration
@EnableSwagger2 //開啟swagger2
public class SwaggerConfig {
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //是否啟動swagger
//                .enable(false)
                .groupName("盧澤龍")
                .select()
                //RequestHandlerSelectors:配置要掃描的接口方式
//                    basePackage : 指定要掃描的包
                    .apis(RequestHandlerSelectors.basePackage("org.lzl.laboratory.controller"))
//                    any:掃描全部
//                    .apis(RequestHandlerSelectors.any())
//                    none：不掃描
//                    .apis(RequestHandlerSelectors.none())
//                    withClassAnnotation：掃描類上的注解
//                    .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
//                    withMethodAnnotation:掃描方法上的注解
//                    .apis(RequestHandlerSelectors.withMethodAnnotation(GetMapping.class))
                //path() 過濾什么路徑
//                    .paths(PathSelectors.ant("/lzl/**"))
                .build();
    }

 //配置swagger信息 ==> apiInfo
    private ApiInfo apiInfo(){
        //作者信息
        Contact contact = new Contact("盧澤龍","https://blog.csdn.net/MoastAll","382491212@qq.com");

        return new ApiInfo(
                "云上實(shí)驗(yàn)室的API文檔說明",
                "abcdefg",
                "v1.0",
                "https://blog.csdn.net/MoastAll",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList()
        );
    }
 }

其中如果有這樣的需求：在dev，test環(huán)境中開啟swagger，其他環(huán)境不開啟swagger，我們只需要給Docket加上下面的environment參數(shù)，再用acceptsProfiles方法來判斷環(huán)境是否符合要求！

在這里插入圖片描述