(1)导入jar包
    Swagger:老版本的，默认页面：swagger-ui.html

    io.springfox
    springfox-swagger2
    2.9.2


    io.springfox
    springfox-swagger-ui
    2.9.2


    knife4j：新版本，默认页面：doc.html

    com.github.xiaoymin
    knife4j-spring-boot-starter
    3.0.3

    (2)在config中添加一个在线文档配置类

    1. package com.mhy.boot.config;
    2. //⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
    3. //        ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⡖⠒⠒⠤⢄⠀⠀
    4. //        ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢸⠁⠀⠀⠀⡼⠀⠀⠀⠀ ⠀
    5. //        ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢶⣲⡴⣗⣲⡦⢤⡏⠀⠀⠀⠀⠀
    6. //        ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣰⠋⠉⠉⠓⠛⠿⢷⣶⣦⠀⠀⠀
    7. //        ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢠⠇⠀⠀⠀⠀⠀⠀⠘⡇⠀⠀⠀⠀
    8. //        ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⡞⠀⠀⠀⠀⠀⠀⠀⢰⠇⠀⠀⠀⠀
    9. //        ⠀⠀⠀⠀⠀⠀⠀⠀⡴⠊⠉⠳⡄⠀⢀⣀⣀⡀⠀⣸⠀⠀⠀⠀⠀
    10. //        ⠀⠀⠀⠀⠀⠀⠀⢸⠃⠀⠰⠆⣿⡞⠉⠀⠀⠉⠲⡏⠀⠀⠀⠀⠀
    11. //        ⠀⠀⠀⠀⠀⠀⠀⠈⢧⡀⣀⡴⠛⡇⠀:⠃⠀⠀⡗⠀⠀⠀⠀⠀
    12. //        ⠀⠀⠀⠀⠀⠀⠀⠀⠀⣿⣱⠃⡴⠙⠢⠤⣀⠤⡾⠁⠀⠀⠀⠀⠀
    13. //        ⠀⠀⠀⠀⠀⠀⠀⠀⢀⡇⣇⡼⠁⠀⠀⠀⠀⢰⠃⠀⠀⠀⠀⠀⠀
    14. //        ⠀⠀⠀⠀⠀⠀⠀⠀⣸⢠⣉⣀⡴⠙⠀⠀⠀⣼⠀⠀⠀⠀⠀⠀⠀
    15. //        ⠀⠀⠀⠀⠀⠀⠀⠀⡏⠀⠈⠁⠀⠀⠀⠀⢀⡇⠀⠀⠀⠀⠀⠀⠀
    16. //        ⠀⠀⠀⠀⠀⠀⠀⢸⠃⠀⠀⠀⠀⠀⠀⠀⡼⠀⠀⠀⠀⠀⠀⠀⠀
    17. //        ⠀⠀⠀⠀⠀⠀⠀⢸⠀⠀⠀⠀⠀⠀⠀⣰⠃⠀⠀⠀⠀⠀⠀⠀⠀
    18. //        ⠀⠀⠀⠀⠀⣀⠤⠚⣶⡀⢠⠄⡰⠃⣠⣇⠀⠀⠀⠀⠀⠀⠀⠀⠀
    19. //        ⠀⢀⣠⠔⣋⣷⣠⡞⠀⠉⠙⠛⠋⢩⡀⠈⠳⣄⠀⠀⠀⠀⠀⠀⠀
    20. //        ⠀⡏⢴⠋⠁⠀⣸⠁⠀⠀⠀⠀⠀⠀⣹⢦⣶⡛⠳⣄⠀⠀⠀⠀⠀
    21. //        ⠀⠙⣌⠳    小马无忧  ⡏⠀⠀⠈⠳⡌⣦⠀⠀⠀
    22. //        ⠀⠀⠈⢳⣈⣻        ⢰⣇⣀⡠⠴⢊⡡⠋⠀⠀⠀⠀
    23. //        ⠀⠀⠀⠀⠳⢿⡇⠀⠀⠀⠀⠀⠀⢸⣻⣶⡶⠊⠁⠀⠀
    24. //        ⠀⠀⠀⠀⠀⢠⠟⠙⠓⠒⠒⠒⠒⢾⡛⠋⠁⠀⠀⠀⠀⠀⠀⠀⠀
    25. //        ⠀⠀⠀⠀⣠⠏⠀⣸⠏⠉⠉⠳⣄⠀⠙⢆⠀⠀⠀⠀⠀⠀⠀⠀⠀
    26. //        ⠀⠀⠀⡰⠃⠀⡴⠃⠀⠀⠀⠀⠈⢦⡀⠈⠳⡄⠀⠀⠀⠀⠀⠀⠀
    27. //        ⠀⠀⣸⠳⣤⠎⠀⠀⠀⠀⠀⠀⠀⠀⠙⢄⡤⢯⡀⠀⠀⠀⠀⠀⠀
    28. //        ⠀⠐⡇⠸⡅⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠹⡆⢳⠀⠀⠀⠀⠀⠀
    29. //        ⠀⠀⠹⡄⠹⡄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣇⠸⡆⠀⠀⠀⠀⠀
    30. //        ⠀⠀⠀⠹⡄⢳⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢹⡀⣧⠀⠀⠀⠀⠀
    31. //        ⠀⠀⠀⠀⢹⡤⠳⡄⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣷⠚⣆⠀⠀⠀⠀
    32. //        ⠀⠀⠀⡠⠊⠉⠉⢹⡀⠀⠀⠀⠀⠀⠀⠀⠀⢸⡎⠉⠀⠙⢦⡀⠀
    33. //        ⠀⠀⠾⠤⠤⠶⠒⠊⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠉⠙⠒⠲⠤⠽⠀
    34.         import io.swagger.annotations.Api;
    35.         import org.springframework.context.annotation.Bean;
    36.         import org.springframework.context.annotation.Configuration;
    37.         import springfox.documentation.builders.ApiInfoBuilder;
    38.         import springfox.documentation.builders.RequestHandlerSelectors;
    39.         import springfox.documentation.service.ApiInfo;
    40.         import springfox.documentation.service.Contact;
    41.         import springfox.documentation.spi.DocumentationType;
    42.         import springfox.documentation.spring.web.plugins.Docket;
    43.         import springfox.documentation.swagger2.annotations.EnableSwagger2;
    45. /**
    46.  * @author Feri
    47.  * @date 2021/12/27 11:44
    48.  * @description:TODO
    49.  */
    50. @Configuration //标记这是配置类，beans
    51. @EnableSwagger2 //启用Swagger
    52. public class SwaggerConfig {
    53.     /**
    54.      * 构建文档的基本信息
    55.      */
    56.     public ApiInfo createApi(){
    57.         return new ApiInfoBuilder().description("员工项目的接口在线文档,可以对接口进行测试等操作")
    58.                 .title("员工项目的接口文档").contact(new Contact("mhy","http://www.qfedu.com","xingfei_work@163.com"))
    59.                 .version("1.0.0").build();
    60.     }
    62.     /**
    63.      * 就是ioc创建实例 修饰方法 方法必须返回对象
    64.      */
    65.     @Bean
    66.     public Docket createDocket(){
    67.         return new Docket(DocumentationType.SWAGGER_2).apiInfo(createApi())
    68. //                .select().apis(RequestHandlerSelectors.basePackage("com.mhy.boot.Controller"))//需要改
    69.                 .select().apis(RequestHandlerSelectors.withClassAnnotation(Api.class))///一劳永逸不用改
    71.                 .build();
    72.     }
    74. }

    image.png

    配合三个注解使用:@Api(_value = “这是用户操作接口”,tags = “这是用户操作姐口”)对类使用
    @ApiOperation    (value = “这是增加方法”)对方法使用
    @ApiParam    (value = “当前页数”)对参数使用_