Spring Boot 配置Swagger 31 Maven依赖2 SwaggerConfig3 调试代码 4 Swagger3调试页面

62 阅读 0 评论 41 点赞

我是靠谱客的博主野性戒指，最近开发中收集的这篇文章主要介绍Spring Boot 配置Swagger 31 Maven依赖2 SwaggerConfig3 调试代码 4 Swagger3调试页面，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

1 Maven依赖

        <!-- Swagger 3 API接口调试工具        -->
        <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;
    }
}