Swagger2使用_gwapidesc 附件-优快云博客

本文链接：https://blog.youkuaiyun.com/qq_31600523/article/details/102586902

本文介绍如何在项目中引入Swagger2并配置基础类，实现API文档的自动生成。通过POM文件添加依赖，编写Swagger2Config类，并在Controller中使用注解，详细展示如何标注接口和操作说明。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

pom引用

      <!-- swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.8.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.8.0</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>2.9.6</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.9.6</version>
        </dependency>

Swagger2Config基础类编写

@EnableWebMvc
@Configuration
@EnableSwagger2
public class Swagger2Config {

	@Value("true")
	private boolean enable;


	@Bean("gwApi")
	public Docket shopGwApis() {
		return new Docket(DocumentationType.SWAGGER_2)
				.groupName("gwApi")
				.select()
				.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
				.paths(PathSelectors.regex("/(a|b|b|d)/.*"))
				.build()
				.apiInfo(apiInfo())
				.enable(enable);
	}

	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				.title("接口文档")
				.description("包含服务")
				.version("1.0")
				.build();
	}

3 controller使用

api注解：

@Api(description = "ssssss", tags = "Assissssssse")

api操作注解（注解在方法上）标注该操作的说明，类路径的参数使用ApiImplicitParams

  @ApiOperation("da)
    @ApiImplicitParams({
            @ApiImplicitParam(name = "busindasdade", value = "daD", required = true, paramType = "path")
            @ApiImplicitParam(name = "da, value = "daD", required = true, paramType = "path")),
    })

实体参数注解

@ApiModel
 @ApiModelProperty(required = true,value = "desc")

访问url:
http://{root-path}/swagger-ui.html