Swagger2和Swagger3用法简介

转载

mb5fe18fed96438 2021-10-15 14:27:00

文章标签 Java spring html 正则表达式开发文档 文章分类 代码人生

导入需要的包

地址

Swagger2需要的包

1. Springfox Swagger2
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>3.0.0</version>
</dependency>
2. Springfox Swagger UI
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
  <version>3.0.0</version>
</dependency>

Swagger3需要的包

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-boot-starter</artifactId>
  <version>3.0.0</version>
</dependency>

编写Springboot程序，访问Swagger-ui.html

在SpringBoot启动类上添加@EnableSwagger2注解
注意：不管是swagger2还是swagger3，目前的注解都是@EnableSwagger2，还没有更新。
@EnableSwagger2是springfox提供的液体个注解，代表swagger2相关的技术开启。
会扫描当前类所在包，及子包中的所有类型中的注解。做swagger文档的定值。

Swagger2访问地址：http://localhost:8080/swagger-ui.html
Swagger3访问地址：http://localhost:8080/swagger-ui/ (注意斜杠)

在项目中添加一个类，来对API文档主页的展示信息进行配置

package com.dai.learningsystem.config;


import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class SwaggerConfiguration {
    /**
     * 创建Docket类型的对象。并使用spring容器管理。
     * Docket是Swagger中的全局配置对象。
     *
     * @return
     */
    @Bean
    public Docket docket() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2);

        //这里写的是API文档页面上的信息
        ApiInfo apiInfo = new ApiInfoBuilder()
                .contact(
                        new Contact(
                                "YiFan Dai",             //是文档的发布者名称
                                "http://alvis.club",       //文档发布者的网站地址。一般是企业网站
                                "ivan.dai@nf-3.com")     //文档发布者的电子邮箱
                )
                .title("LS系统开发文档")
                .description("LS系统是个人用于规划学习内容以及即使监控自己学习进度的管理系统。\n" +
                        "目前用到了SpringBoot+MySql+Swagger3+mybatis等技术。")
                .version("1.1")
                .build();
        //给docket上下文配置api描述信息
        docket.apiInfo(apiInfo);


        docket = docket
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.dai.learningsystem.controller"))//用于配置，扫描哪个子包下的注解
                .paths(
                        PathSelectors.regex("/swagger/.*") //使用正则表达式，约束生成API文档的路径地址，即只有/swagger/开始的请求才生成API文档
                )
                .build();
        return docket;
    }
}

最终效果如下：
Swagger2和Swagger3用法简介_spring