Swagger2 及 knife4j 使用
最近项目中用到了 Swagger2 和 knife4j 作为接口文档。所以自己简单搭建了一套环境学习下，总体体验下来，这个框架很方便也很简单易用。
Swagger2 和 Swagger-ui
maven 依赖io.springfox springfox-swagger2 2.9.2 io.springfox springfox-swagger-ui 2.9.2
增加配置文件
@Bean
public Docket controllerApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(new ApiInfoBuilder()
.title("文档说明--API接口文档")
.description("包括保存、查询等")
.version("版本号:1.0")
.build())
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.myswagger.controller"))
.paths(PathSelectors.any()) // 如果适配所有api，可以改为PathSelectors.any()
.build();
}
API 接口增加 swagger 注解
@ApiOperation("根目录")
@GetMapping("/")
@ResponseBody
public String hello(){
System.out.println("23123");
return "hello";
}
@ApiOperation("保存用户信息")
@ApiImplicitParams({
@ApiImplicitParam(name = "name", value = "名字", required = true, paramType = "path"),
@ApiImplicitParam(name = "age", dataType = "int", value = "年龄", required = true, paramType = "query")
})
@PostMapping("/save")
@ResponseBody
public Boolean save(
@RequestParam("name") String name,
@RequestParam("age") Integer age
) {
return true;
}
效果展示
http://localhost:8080/swagger-ui.html
测试接口：
项目地址 https://gitee.com/LylYorick/myswagger
swagger 注解详解
@ApiOperation：用在请求的方法上，说明方法的用途、作用
@ApiImplicitParams：用在请求的方法上，表示一组参数说明
@ApiResponses：用在请求的方法上，表示一组响应
@ApiModel：用于响应类上，表示一个返回响应数据的信息
maven 依赖
1 2 3 4 5 6 7 8 9 10 <dependency > <groupId > com.github.xiaoymin</groupId > <artifactId > knife4j-spring-boot-starter</artifactId > <version > 2.0.8</version > </dependency > <dependency > <groupId > io.springfox</groupId > <artifactId > springfox-swagger2</artifactId > <version > 2.10.5</version > </dependency >
增加配置类
@Bean(value = "defaultApi2")
public Docket defaultApi2() {
Docket docket=new Docket(DocumentationType.SWAGGER_2)
.apiInfo(new ApiInfoBuilder()
//.title("swagger-bootstrap-ui-demo RESTful APIs")
.description("# swagger-bootstrap-ui-demo RESTful APIs")
.termsOfServiceUrl("http://www.xx.com/")
.contact("xx@qq.com")
.version("1.0")
.build())
//分组名称
.groupName("2.X版本")
.select()
//这里指定Controller扫描包路径
.apis(RequestHandlerSelectors.basePackage("com.example.myswaggerknife4j.controller"))
.paths(PathSelectors.any())
.build();
return docket;
}
API 接口增加 swagger 注解
@PostMapping("/save")
@ResponseBody
public Boolean save(
@RequestParam("name") String name,
@RequestParam("age") Integer age
) {
return true;
}
效果展示http://localhost:8080/doc.html
项目地址 https://gitee.com/LylYorick/my-swagger-knife4j
# 关于我Brath 是一个热爱技术的 Java 程序猿，公众号「InterviewCoder」定期分享有趣有料的精品原创文章！
非常感谢各位人才能看到这里，原创不易，文章如果有帮助可以关注、点赞、分享或评论，这都是对我的莫大支持！
