Swagger(JAVA)
文章目录
1.介绍
2.使用
2.1 springMVC集成
1.添加依赖
<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.1</version>
</dependency>
<!-- swagger-ui 为项目提供api展示及测试的界面 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
</dependency>
<!-- 集成 swagger 的时候，缺少这个 jar包是不OK的-->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.8.7</version>
</dependency>
2.编写配置文件
@Configuration
@EnableSwagger2
@EnableWebMvc
@ComponentScan(basePackages ="com.zy.crud")
public 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("SpringMVC swagger的接口测试")
.description("这个是接口测试")
.termsOfServiceUrl("http://blog.****.net/cct")
.contact(new Contact("欢迎来到我的接口测试", "http://blog.****.net", "[email protected]"))
.license("")
.licenseUrl("")
.version("1.0.0")
.build();
}
}
3.编写请求处理类
@Controller
@RequestMapping("/swagger")
public class SwaggerController {
@ApiOperation(value = "打招呼", notes = "这是个方法")
@ResponseBody
@RequestMapping(value = "printHello", method = RequestMethod.GET)
@ApiImplicitParams(
@ApiImplicitParam(name = "userName", value = "名字", required = true, paramType = "query")
)
public String printHello(String userName) {
return "hello,"+userName;
}
}
4.访问 http://localhost:8080/ssm_crud/swagger-ui.html
参考：
Swagger使用指南 - 不能传递参数
swagger2的常用注解，传递参数的注意使用方法
spring mvc 集成 swagger 详细实践
Swagger与SpringMVC项目整合