Spring Boot 配置Swagger 3

浅浅的花香味﹌ 2023-10-02 12:03 9阅读 0赞

## 1 Maven依赖 ##

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

## 2 SwaggerConfig ##

Swagger3配置类。

package com.config;
    
    import io.swagger.annotations.ApiOperation;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.oas.annotations.EnableOpenApi;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    
    /**
     * Swagger3配置类
     */
    @Configuration
    @EnableOpenApi
    public class SwaggerConfig {
        @Bean
        public Docket defaultApi() {
            return new Docket(DocumentationType.OAS_30)
                    .apiInfo(apiInfo())
                    .pathMapping("/")
                    .select()
                    // 选择那些路径和api会生成document
                    .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                    .build();
        }
    
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("接口文档")
                    //描述
                    .description("项目接口文档")
                    .version("1.0")
                    .build();
        }
    
    }

## 3 调试代码 ##

package com.controller;
    
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiImplicitParam;
    import io.swagger.annotations.ApiImplicitParams;
    import io.swagger.annotations.ApiOperation;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @Api(tags = "Swagger测试接口", value = "swagger")
    public class SwaggerController {
        @ApiOperation("测试")
        @ApiImplicitParams({
                @ApiImplicitParam(value = "参数1", name = "arg1", paramType = "query", required = true, dataType = "String"),
                @ApiImplicitParam(value = "参数2", name = "arg2", paramType = "query", required = true, dataType = "String"),
        })
        @GetMapping("test")
        public String test(@RequestParam String arg1, @RequestParam String arg2) {
            return arg1 + arg2;
        }
    }

## 4 Swagger3调试页面 ##

输入以下地址，即可打开Swagger页面，查看接口描述。[http://localhost:8080/swagger-ui/index.html![icon-default.png?t=L9C2][icon-default.png_t_L9C2]http://localhost:8081/swagger-ui/index.html][http_localhost_8080_swagger-ui_index.html_icon-default.png_t_L9C2_icon-default.png_t_L9C2_http_localhost_8081_swagger-ui_index.html]

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5pet5Lic5oCq_size_20_color_FFFFFF_t_70_g_se_x_16][]

[icon-default.png_t_L9C2]: https://csdnimg.cn/release/blog_editor_html/release1.9.2/ckeditor/plugins/CsdnLink/icons/icon-default.png?t=L9C2
[http_localhost_8080_swagger-ui_index.html_icon-default.png_t_L9C2_icon-default.png_t_L9C2_http_localhost_8081_swagger-ui_index.html]: http://localhost:8081/swagger-ui/index.html
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5pet5Lic5oCq_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/bfbb24744a124050939146a9e9686afd.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5pet5Lic5oCq,size_20,color_FFFFFF,t_70,g_se,x_16