如何在SpringBoot中應用Swagger

本篇文章給大家分享的是有關如何在SpringBoot中應用Swagger，小編覺得挺實用的，因此分享給大家學習，希望大家閱讀完這篇文章后可以有所收獲，話不多說，跟著小編一起來看看吧。

springboot是什么

springboot一種全新的編程規范，其設計目的是用來簡化新Spring應用的初始搭建以及開發過程，SpringBoot也是一個服務于框架的框架，服務范圍是簡化配置文件。

一、基本使用

使用時需要導入下面的依賴：

<!--引入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，即可可以看到下面的界面：

二、自定義描述內容

@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(
                "云上實驗室的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環境中開啟swagger，其他環境不開啟swagger，我們只需要給Docket加上下面的environment參數，再用acceptsProfiles方法來判斷環境是否符合要求！

使用的效果為:

三、給下面的models和接口一些提示信息

1.給實體類加入下面的注解

http://localhost:8910/swagger-ui.html的models就會呈現下面的界面：

2.給controller加上下面的注解

就會出現下面的提示信息：

以上就是如何在SpringBoot中應用Swagger，小編相信有部分知識點可能是我們日常工作會見到或用到的。希望你能通過這篇文章學到更多知識。更多詳情敬請關注億速云行業資訊頻道。