《API接口管理Swagger2实战教程》学习笔记

Posted 2021-07-08 COCOgsta

学习视频来源：API接口管理Swagger2实战教程

个人在学习的同时，也验证了视频中的实验部分，现将授课笔记和实验笔记整理下来。

Swagger简介

前言

接口文档对于前后端开发人员都十分重要。尤其近几年流行前后端分离后接口文档又编程重中之重。接口文档固然重要，但是由于项目周期等原因后端人员经常出现无法及时更新，导致前端人员抱怨接口文档和实际情况不一致。

很多人员会抱怨别人写的接口文档不规范，不及时更新。当时当自己写的时候确实最烦去写接口文档。这种痛苦只有亲身经历才会牢记于心。

如果接口文档可以实时动态生成就不会出现上面问题。

Swagger可以完美的解决上面的问题。

Open API是什么

Open API规范（Open API Specification）以前叫做Swagger规范，是REST API的API描述格式。

Open API文件允许描述整个API，包括：

• 每个访问地址的类型。POST或GET。
• 每个操作的参数。包括输入输出参数。
• 认证方法。
• 连接信息，声明，使用团队和其他信息。

Open API规范可以使用YAML或JSON格式进行编写。这样更利于我们和机器进行阅读。

Open API规范（OAS）为REST API定义了一个与语言无关的标准接口，允许人和计算机发现和理解服务的功能，而无需访问源代码，文档或通过网络流量检查。正确定义后，消费者可以使用最少量的实现逻辑来理解远程服务并与之交互。

然后，文档生成工具可以使用OpenAPI定义来显示API，使用各种编程语言生成服务器和客户端的代码生成工具，测试工具以及许多其他用例。

Swagger简介

Swagger是一套围绕Open API规范构建的开源工具，可以帮助设计，构建，记录和使用REST API。

Swagger工具包括的组件：

• Swagger Editor：基于浏览器编辑器，可以在里面编写Open API规范。类似Markdown具有实时预览描述文件的功能。（很少用）
• Swagger UI：将Open API规范呈现为交互式API文档。用可视化UI展示描述文件。
• Swagger Codegen：将Open API规范生成为服务器存根和客户端库。通过Swagger Codegen可以将描述文件生成html格式和cwiki形式的接口文档，同时也可以生成多种语言的客户端和服务端代码。
• Swagger Inspector：和Swagger UI有点类似，但是可以返回更多信息，也会保存请求的实际参数数据。
• Swagger Hub：集成了上面所有项目的各个功能，你可以以项目和版本为单位，将你的描述文件上传到Swagger Hub中。在Swagger Hub中可以完成上面项目的所有工作，需要注册账号，分免费版和收费版。

使用Swagger，就是把相关的信息存储在它定义的描述文件里面（yml或json格式），再通通过维护这个描述文件可以去更新接口文档，以及生成各端代码

Springfox

使用Swagger时如果碰见版本更新或迭代时，只需要更改Swagger的描述文件即可。但是在频繁的更新项目版本时很多开发人员认为即使修改描述文件（yml或json）也是一定的工作负担，久而久之就直接修改代码，而不去修改描述文件了，这样基于描述文件生成接口文档也失去了意义。

Marty Pitt编写了一个基于Spring的组件swagger-springmvc。Spring-fox就是根据这个组件发展而来的全新项目。

Spring-fox是根据代码生成接口文档，所以正常的进行更新项目版本，修改代码即可，而不需要跟随修改描述文件。

Spring-fox利用自身AOP特性，把Swagger集成进来，底层还是Swagger。但是使用起来确实方便很多。

所以在实际开发中，都是直接使用spring-fox。

Swagger极致用法

安装JDK1.8.0_171、MAVEN 3.8.1（可参考百度搜索）

编写SpringBoot项目

创建项目

指定项目名称和路径

导入Spring-fox依赖

修改pom.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.bjsxt</groupId>
    <artifactId>swagger</artifactId>
    <version>1.0-SNAPSHOT</version>


    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.2.5.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>

        </dependencies>
    </dependencyManagement>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <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>
    </dependencies>


</project>

注意添加完后需要下载相应依赖，下载完后会出现“Dependencies”

添加注解

创建MyController

package com.bjsxt.controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 * Created by guoliang on 2021/6/7.
 */
@RestController
public class MyController {
    @PostMapping("/post")
    public String post() {
        return "post";
    }
    @GetMapping("/get")
    public String get(String a, String b) {
        return "get";
    }
    @RequestMapping("/req")
    public String req(String m) {
        return "req";
    }
}

创建MyApp

package com.bjsxt;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
 * EnableSwagger2 - 是springfox提供的一个注解，代表swagger2相关技术开启。
 * 会扫描当前类所在包，及子包中所有的类型中的注解。做swagger文档的定制。
 */
@SpringBootApplication
@EnableSwagger2
public class MyApp {
    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }
}

访问swagger-ui

运行MyApp后可打开Swagger页面

Swagger-UI使用

访问swagger-ui.html后可以在页面看到所有生成接口文档的控制器名称。

Swagger配置

可以在项目中创建SwaggerConfig，进行配置文档内容

配置基本信息

• Docket：摘要对象，通过对象配置描述文件的信息
• apiInfo：设置描述文件中info。参数类型ApiInfo
• select()：返回ApiSelectorBuilder对象，通过对象调用build()可以创建Docket对象
• ApiInfoBuilder：ApiInfo构建器

创建SwaggerConfiguration.java文件

package com.bjsxt.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
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帮助文档的描述信息。 information
        ApiInfo apiInfo =
                new ApiInfoBuilder()
                        .contact( // 配置swagger文档主体内容。
                                new Contact(
                                        "北京尚学堂 - Old Jin", //是文档的发布者名称
                                        "http://www.bjsxt.com", // 是文档发布者的网站地址。企业网站
                                        "[e-mail]") // 文档发布者的电子邮箱
                        )
                        .title("Swagger框架学习帮助文档")
                        .description("Swagger框架帮助文档详细描述 - Swagger框架是一个用于开发RestAPI帮助文档")
                        .version("1.1")
                        .build();
        // 给docket上下文配置api描述信息
        docket.apiInfo(apiInfo);
        return docket;
    }
}

配置完后运行效果如下

设置扫描的包

修改SwaggerConfiguration.java

package com.bjsxt.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.ApiInfoBuilder;
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帮助文档的描述信息。 information
        ApiInfo apiInfo =
                new ApiInfoBuilder()
                        .contact( // 配置swagger文档主体内容。
                                new Contact(
                                        "北京尚学堂 - Old Jin", //是文档的发布者名称
                                        "http://www.bjsxt.com", // 是文档发布者的网站地址。企业网站
                                        "[e-mail]") // 文档发布者的电子邮箱
                        )
                        .title("Swagger框架学习帮助文档")
                        .description("Swagger框架帮助文档详细描述 - Swagger框架是一个用于开发RestAPI帮助文档")
                        .version("1.1")
                        .build();
        // 给docket上下文配置api描述信息
        docket.apiInfo(apiInfo);
        docket
                .select() //获取Docket中的选择器。返回ApiSelectorBuilder。构建选择器的。如：扫描什么包的注解。
                .apis(RequestHandlerSelectors.basePackage("com.bjsxt.controller"));  // 设定扫描哪个包（包含子包）中的注解。
        return docket;
    }
}

自定义注解设置不需要生成接口文档的方法

自定义注解

@Target(value={ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotationSwagger {

}

添加规则

创建anno.MyAnnotation4Swagger.java

package com.bjsxt.anno;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
 * @Target - 描述当前的注解可以定义在什么资源上。
 *  属性 value
 *   - 定义具体的资源。 包括：
 *    - ElementType.METHOD 可以定义在方法上
 *    - ElementType.TYPE 可以定义在类型上
 *    - ElementType.FIELD 可以定义在属性上
 *    - ElementType.PARAMETER 可以定义在方法参数上
 * @Retention - 当前注解在什么时候有效
 *  属性 value
 *   - 定义具体的生效标记
 *    - RetentionPolicy.RUNTIME - 运行时有效
 *    - RetentionPolicy.SOURCE - 源码中有效
 *    - RetentionPolicy.CLASS - 字节码有效
 */
@Target(value={ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation4Swagger {
    // 自定义注解中的属性。相当于 @MyAnnotation4Swagger(value="")
    String value() default "";
}

添加NotIncludeSwagger注解

修改MyController.java

package com.bjsxt.controller;
import com.bjsxt.anno.MyAnnotation4Swagger;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 * Created by guoliang on 2021/6/7.
 */
@RestController
public class MyController {
    @PostMapping("/post")
    public String post() {
        return "post";
    }
    @GetMapping("/get")
    public String get(String a, String b) {
        return "get";
    }
    @MyAnnotation4Swagger //增加该注解
    @RequestMapping("/req")
    public String req(String m) {
        return "req";
    }
}

重新运行MyApp

不再包含/req

设置范围

通过public ApiSelectorBuilder paths(Predicate<Strting> selector)可以设置满足什么样规则的url被生成接口文档。可以使用正则表达式进行匹配。

修改SwaggerConfiguration.java

package com.bjsxt.config;
import com.bjsxt.anno.MyAnnotation4Swagger;
import com.google.common.base.Predicates;
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帮助文档的描述信息。 information
        ApiInfo apiInfo =
                new ApiInfoBuilder()
                        .contact( // 配置swagger文档主体内容。
                                new Contact(
                                        "北京尚学堂 - Old Jin", //是文档的发布者名称
                                        "http://www.bjsxt.com", // 是文档发布者的网站地址。企业网站
                                        "[e-mail]") // 文档发布者的电子邮箱
                        )
                        .title("Swagger框架学习帮助文档")
                        .description("Swagger框架帮助文档详细描述 - Swagger框架是一个用于开发RestAPI帮助文档")
                        .version("1.1")
                        .build();
        // 给docket上下文配置api描述信息
        docket.apiInfo(apiInfo);
        docket = docket
                .select() //获取Docket中的选择器。返回ApiSelectorBuilder。构建选择器的。如：扫描什么包的注解。
                .apis(
                        Predicates.not( //取反。false -> true true -> false
                                RequestHandlerSelectors.withMethodAnnotation( // 当方法上有注解的时候返回true
                                        MyAnnotation4Swagger.class) // 方法上游什么注解的时候返回true
                        ))
                .apis(RequestHandlerSelectors.basePackage("com.bjsxt.controller"))  // 设定扫描哪个包（包含子包）中的注解。
                .paths(
                        Predicates.or( // 多个规则符合任意一个即可通过。
                                PathSelectors.regex("/swagger/.*"), // 使用正则表达式，约束生成API文档的路径地址。
                                PathSelectors.regex("/swagger2/.*"),
                                PathSelectors.regex("/.*")
                        )
                )
                .build(); // 重新构建Docket对象
        return docket;
    }
}

修改MyController.java

package com.bjsxt.controller;
import com.bjsxt.anno.MyAnnotation4Swagger;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 * Created by guoliang on 2021/6/7.
 */
@RestController
@RequestMapping("/swagger")
public class MyController {
    @PostMapping("/post")
    public String post() {
        return "post";
    }
    @GetMapping("/get")
    public String get(String a, String b) {
        return "get";
    }
    @MyAnnotation4Swagger //增加该注解
    @RequestMapping("/req")
    public String req(String m) {
        return "req";
    }
}

重新运行MyApp

指定路径，且只有匹配路径的才显示

Swagger2常用注解

Api

修改MyController.java

package com.bjsxt.controller;
import com.bjsxt.anno.MyAnnotation4Swagger;
import io.swagger.annotations.Api;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 * @Api - 描述当前类型生成帮助文档的信息
 *  属性 -
 *   - tags：给当前类型定义别名，可以有多个。定义几个别名，在ui视图中就显示几个控制器访问菜单。
 *   - description：给当前类型生成的帮助文档定义一个描述信息。
 */
@RestController
@RequestMapping("/swagger")
@Api(tags = {"MyController", "Swagger学习控制器"}, description = "测试API类型描述信息")
public class MyController {
    @PostMapping("/post")
    public String post() {
        return "post";
    }
    @GetMapping("/get")
    public String get(String a, String b) {
        return "get";
    }
    @MyAnnotation4Swagger //增加该注解
    @RequestMapping("/req")
    public String req(String m) {
        return "req";
    }
}

ApiOperation

修改MyController.java

package com.bjsxt.controller;
import com.bjsxt.anno.MyAnnotation4Swagger;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 * @Api - 描述当前类型生成帮助文档的信息
 *  属性 -
 *   - tags：给当前类型定义别名，可以有多个。定义几个别名，在ui视图中就显示几个控制器访问菜单。
 *   - description：给当前类型生成的帮助文档定义一个描述信息。
 */
@RestController
@RequestMapping("/swagger")
@Api(tags = {"MyController", "Swagger学习控制器"}, description = "测试API类型描述信息")
public class MyController {
    @PostMapping("/post")
    @ApiOperation(value="post方法，执行数据新增操作", notes = "Swagger学习使用-处理POST请求的方法")
    public String post() {
        return "post";
    }
    @GetMapping("/get")
    public String get(String a, String b) {
        return "get";
    }
    @MyAnnotation4Swagger //增加该注解
    @RequestMapping("/req")
    public String req(String m) {
        return "req";
    }
}

ApiParam

修改MyController.java

package com.bjsxt.controller;
import com.bjsxt.anno.MyAnnotation4Swagger;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 * @Api - 描述当前类型生成帮助文档的信息
 *  属性 -
 *   - tags：给当前类型定义别名，可以有多个。定义几个别名，在ui视图中就显示几个控制器访问菜单。
 *   - description：给当前类型生成的帮助文档定义一个描述信息。
 */
@RestController
@RequestMapping("/swagger")
@Api(tags = {"MyController", "Swagger学习控制器"}, description = "测试API类型描述信息")
public class MyController {
    @PostMapping("/post")
    @ApiOperation(value="post方法，执行数据新增操作", notes = "Swagger学习使用-处理POST请求的方法")
    public String post(
            @ApiParam(name = "用户名", value = "新增用户时提供的用户名", required = true) String a,
            @ApiParam(name = "密码", value = "新增用户提供的密码", required = true) String b) {
        return "post";
    }
    @GetMapping("/get")
    public String get(String a, String b) {
        return "get";
    }
    @MyAnnotation4Swagger //增加该注解
    @RequestMapping("/req")
    public String req(String m) {
        return "req";
    }
}

ApiIgnore

修改MyController.java，get方法不再显示

package com.bjsxt.controller;
import com.bjsxt.anno.MyAnnotation4Swagger;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.annotations.ApiIgnore;
/**
 * @Api - 描述当前类型生成帮助文档的信息
 *  属性 -
 *   - tags：给当前类型定义别名，可以有多个。定义几个别名，在ui视图中就显示几个控制器访问菜单。
 *   - description：给当前类型生成的帮助文档定义一个描述信息。
 */
@RestController
@RequestMapping("/swagger")
@Api(tags = {"MyController", "Swagger学习控制器"}, description = "测试API类型描述信息")
public class MyController {
    @PostMapping("/post")
    @ApiOperation(value="post方法，执行数据新增操作", notes = "Swagger学习使用-处理POST请求的方法")
    public String post(
            @ApiParam(name = "用户名", value = "新增用户时提供的用户名", required = true) String a,
            @ApiParam(name = "密码", value = "新增用户提供的密码", required = true) String b) {
        return "post";
    }
    // ApiIgnore - 忽略，当前注解描述的方法或类型，不生成api帮助文档。
    @ApiIgnore
    @GetMapping("/get")
    public String get(String a, String b) {
        return "get";
    }
    @MyAnnotation4Swagger //增加该注解
    @RequestMapping("/req")
    public String req(String m) {
        return "req";
    }
}

ApiImplicitParams

修改MyController.java

package com.bjsxt.controller;
import com.bjsxt.anno.MyAnnotation4Swagger;
import io.swagger.annotations.*;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.annotations.ApiIgnore;
/**
 * @Api - 描述当前类型生成帮助文档的信息
 *  属性 -
 *   - tags：给当前类型定义别名，可以有多个。定义几个别名，在ui视图中就显示几个控制器访问菜单。
 *   - description：给当前类型生成的帮助文档定义一个描述信息。
 */
@RestController
@RequestMapping("/swagger")
@Api(tags = {"MyController", "Swagger学习控制器"}, description = "测试API类型描述信息")
public class MyController {
    @GetMapping("/test")
    //@ApiImplicitParam(name = "m", value = "m参数描述", required = false, paramType = "字符串", dataType = "名值对")
    @ApiImplicitParams(value = {
            @ApiImplicitParam(name = "m", value = "m参数描述", required = false, paramType = "字符串", dataType = "名值对"),
            @ApiImplicitParam(name = "n", value = "n参数描述", required = true, paramType = "字符串(String)", dataType = "名值对")
    })
    public String test(String m, String n) {
        return "test";
    }
    @PostMapping("/post")
    @ApiOperation(value="post方法，执行数据新增操作", notes = "Swagger学习使用-处理POST请求的方法")
    public String post(
            @ApiParam(name = "用户名", value = "新增用户时提供的用户名", required = true) String a,
            @ApiParam(name = "密码", value = "新增用户提供的密码", required = true) String b) {
        return "post";
    }
    // ApiIgnore - 忽略，当前注解描述的方法或类型，不生成api帮助文档。
    @ApiIgnore
    @GetMapping("/get")
    public String get(String a, String b) {
        return "get";
    }
    @MyAnnotation4Swagger //增加该注解
    @RequestMapping("/req")
    public String req(String m) {
        return "req";
    }
}

ApiModel

新建MyEntity.java

package com.bjsxt.entity;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;
/**
 * ApiModel - 描述一个实体类型。这个实体类型如果成为任何一个生成api帮助文档方法的返回值类型的时候，此注解被解析
 */
@ApiModel(value = "自定义实体-MyEntity", description = "MyEntity存储用户数据")
public class MyEntity implements Serializable{
    @ApiModelProperty(value = "主键", name = "主键(id)",
            required = false, example = "1", hidden = false
    )
    private String id;
    @ApiModelProperty(value = "姓名", name = "姓名(name)",
            required = true, example = "张三", hidden = false
    )
    private String name;
    @ApiModelProperty(value = "密码", name = "密码(password)",
            required = true, example = "my-password-123", hidden = false
    )
    private String password;
    public MyEntity(){}
    public String getId() {
        return id;
    }
    public void setId(String id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        MyEntity myEntity = (MyEntity) o;
        if (id != null ? !id.equals(myEntity.id) : myEntity.id != null) return false;
        if (name != null ? !name.equals(myEntity.name) : myEntity.name != null) return false;
        return password != null ? password.equals(myEntity.password) : myEntity.password == null;
    }
    @Override
    public int hashCode() {
        int result = id != null ? id.hashCode() : 0;
        result = 31 * result + (name != null ? name.hashCode() : 0);
        result = 31 * result + (password != null ? password.hashCode() : 0);
        return result;
    }
}

修改MyController.java

package com.bjsxt.controller;
import com.bjsxt.anno.MyAnnotation4Swagger;
import com.bjsxt.entity.MyEntity;
import io.swagger.annotations.*;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.annotations.ApiIgnore;
/**
 * @Api - 描述当前类型生成帮助文档的信息
 *  属性 -
 *   - tags：给当前类型定义别名，可以有多个。定义几个别名，在ui视图中就显示几个控制器访问菜单。
 *   - description：给当前类型生成的帮助文档定义一个描述信息。
 */
@RestController
@RequestMapping("/swagger")
@Api(tags = {"MyController", "Swagger学习控制器"}, description = "测试API类型描述信息")
public class MyController {
    @RequestMapping("/testEntity")
    public MyEntity testEntity(){
        return new MyEntity();
    }
    @GetMapping("/test")
    //@ApiImplicitParam(name = "m", value = "m参数描述", required = false, paramType = "字符串", dataType = "名值对")
    @ApiImplicitParams(value = {
            @ApiImplicitParam(name = "m", value = "m参数描述", required = false, paramType = "字符串", dataType = "名值对"),
            @ApiImplicitParam(name = "n", value = "n参数描述", required = true, paramType = "字符串(String)", dataType = "名值对")
    })
    public String test(String m, String n) {
        return "test";
    }
    @PostMapping("/post")
    @ApiOperation(value="post方法，执行数据新增操作", notes = "Swagger学习使用-处理POST请求的方法")
    public String post(
            @ApiParam(name = "用户名", value = "新增用户时提供的用户名", required = true) String a,
            @ApiParam(name = "密码", value = "新增用户提供的密码", required = true) String b) {
        return "post";
    }
    // ApiIgnore - 忽略，当前注解描述的方法或类型，不生成api帮助文档。
    @ApiIgnore
    @GetMapping("/get")
    public String get(String a, String b) {
        return "get";
    }
    @MyAnnotation4Swagger //增加该注解
    @RequestMapping("/req")
    public String req(String m) {
        return "req";
    }
}

​​​​​​​