swagger2+springfox+springmvc

xiaoxiao2021-02-28  39

1.pom中添加依赖

<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.7.0</version>

</dependency>

2.

package com.xxx.xxx.xxx.config;

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.service.ApiInfo;import springfox.documentation.spi.DocumentationType;import springfox.documentation.spring.web.plugins.Docket;import springfox.documentation.swagger2.annotations.EnableSwagger2;@Configuration@EnableSwagger2public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .build() .apiInfo(apiInfo()); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("对外开放接口API 文档") .description("HTTP对外开放接口") .version("1.0.0") .termsOfServiceUrl("http://xxx.xxx.com") .license("LICENSE") .licenseUrl("http://xxx.xxx.com") .build(); }

}

3.springmvc中

4.注解使用

4.1加在类上

@Api(value = "AbilityController", tags = "ability接口")  

3.2加在方法上

@ApiOperation(value = "分页获取能力数据", notes = "分页获取能力数据", httpMethod = "POST",produces = MediaType.APPLICATION_JSON_UTF8_VALUE) @ApiImplicitParams(value={ @ApiImplicitParam(name="page",required=true,paramType="query",dataType="Integer"), @ApiImplicitParam(name="limit",required=true,paramType="query",dataType="Integer")

})

@ApiOperation(value = "保存或更新能力", notes = "保存或更新能力", httpMethod = "POST",produces = MediaType.APPLICATION_JSON_UTF8_VALUE)

3.3加在参数上

@ApiParam(value = "能力id",required = true)

NOTE

1.注意@ApiImplicitParam与@ApiParam的使用区别

2.注意参数类型的不同与produces = MediaType.APPLICATION_JSON_UTF8_VALUE使用的问题

3.参数是否显示问题

4.token设置问题

5.访问页面时 提示 。。。baseurl。。。。时   注意1.config上是否有@EnableSwagger2 2.清缓存 clean project 移除项目clean tomcat等 

6.query用于查询参数  header 用于token类

3.检查springmvc是否有这些注解

<!-- 设置使用注解的类所在的jar包 --> <context:component-scan base-package="com.bestmath.app.api" /><bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter" />

============================================================================

搭建springmvc 并 整合swagger 详见转载

https://my.oschina.net/wangmengjun/blog/907679

转载请注明原文地址: https://www.6miu.com/read-2613354.html

最新回复(0)