swagger接口文档生成工具
java宝典
共 1199字,需浏览 3分钟
·
2021-02-08 17:38
文章首推
今日主题:swagger接口文档生成工具
简介
在一个大的的项目中可能会有很多控制类,每个控制类中会有很多方法,这时候我们需要一个接口文档生成工具来暴露这些接口,方便我们进行直接查找测试,确实是方便了很多,那么来学习一下吧
环境
- springboot
- swagger2.x
实现过程
1、创建一个springboot
项目工程,添加依赖
io.springfox
springfox-swagger-ui
2.4.0
io.springfox
springfox-swagger2
2.4.0
2、添加配置文件
//swagger2的配置文件,在项目的启动类的同级文件建立
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select() // 选择那些路径和api会生成document
.apis(RequestHandlerSelectors.any()) // 对所有api进行监控
.paths(PathSelectors.any()) // 对所有路径进行监控
.build();
}
}
3、准备控制类
@PostMapping("/hello")
@ApiOperation(value = "测试",notes = "这是一个测试文档")
public String hello(){
return "hello";
}
4、启动项目,访问地址:http://localhost:端口/swagger-ui.html/
这里可以进行测试
Swagger全部是以JSON的格式向后台传参的
这是非常重要的一点,我自己找了很多文章才发现的,入参都是以json格式的,也就是说只支持@RequestBody
的入参。
想下面这个就不行:
@GetMapping("/test")
public String test(String test){
return test;
}
大家可以看到响应体是no content
其实这里也已经给我们答案了,参数类型只支持json格式
欢迎关注:java后端指南
请给鹏哥点个在看吧
![e67c2272191c6583c75b626856efd65c.webp](https://filescdn.proginn.com/774a4ad4da10c6542ee62ddf7d7f4a40/e67c2272191c6583c75b626856efd65c.webp)
评论
Evalon4JJava 接口文档生成工具
Evalon4J是一个Java接口文档生成工具,直接通过命令行使用,支持Spring-MVC,JAX-RS,Swagger2.0等多种框架注解。同时它是付费产品 RabiAPI 使用的底层框架,通过静
Evalon4JJava 接口文档生成工具
0
Apidoc-phpAPI 接口文档生成工具
Apidoc是一个通过解析注解生成API接口文档的PHPcomposer扩展,支持在线调试、Mock数据、Md文档等功能。 全面的注解引用、数据表字段引用,简单的注解即可生成Api文档,而Apidoc
Apidoc-phpAPI 接口文档生成工具
0
swammdoc接口文档自动生成工具
swammdoc接口文档自动生成工具如图: 团队协作离不开约定,规范,最早我们用word,excel编写接口文档,现在有了开源,涌现了一批接口文档管理平台,rap,小幺鸡,apiManager等等,有
swammdoc接口文档自动生成工具
0