Spring Cloud Swagger(接口管理)
来源:互联网 发布:数据挖掘的过程 编辑:程序博客网 时间:2024/05/17 21:57
1.Swagger介绍
Swagger用于在类或者方法上通过注解的方式生成API接口,然后使用Swagger-ui这个项目去浏览这些接口,就不用手动的去写word/Excel接口文档了。
这个接口文档因为是通过代码注解生成的,所以是实时体现了接口的变化。另一个重要的功能是,可以基于swagger-ui测试这些接口。
2.实战
1)Maven关键配置
<dependency> <groupId>com.mangofactory</groupId> <artifactId>swagger-springmvc</artifactId> <version>1.0.2</version> </dependency>
2)下载swagger-ui项目,将项目里的dict文件夹copy到web项目的webapp目录下。
3)对想要生成的接口用swagger提供的方法进行注解。
- 类使使用@Api注解
- 方法使用@ApiOperation注解
- 参数使用@ApiParam注解
- 如果方法不想暴露出去,需要用@ApiIgnore注解,否则sagger-ui会对没有标注@ApiIgnore和@ApiOperation的方法对http协议中 GET/POST/DELETE/HEAD/PATCH/PUT/OPTIONS分别生成对对应的方法。
注解后的截图如下:
浏览swagger-ui
如上图,因为/users/query没有使用@ApiIgnore注解,所以被swagger-ui按照http中的协议分别生成了方法。这些接口是可测试的,点击/users/query,可出现如下:
点击试一下,即可调用接口方法。
阅读全文
0 0
- Spring Cloud Swagger(接口管理)
- Swagger API接口管理
- spring-boot集成swagger(接口管理工具)
- 【Spring Cloud】spring boot搭建+swagger-ui
- spring cloud整合swagger,通过zuul路由
- 基于swagger做接口管理
- 基于swagger做接口管理
- 基于swagger做接口管理
- Swagger+Spring开发Rest接口
- spring boot rest接口自动生成文档(包含swagger)
- Swagger-UI与Spring Cloud整合与安全设置
- Spring Cloud Eureka 控制台快速查看Swagger API文档
- Swagger+Spring mvc生成Restful接口文档
- Swagger+Spring mvc生成Restful接口文档
- Swagger+Spring mvc生成Restful接口文档
- Spring Boot -- Swagger之接口分组
- Spring结合Swagger实现API管理
- 【Spring Cloud】Feign接口调用
- 使用JavaScript和MQTT开发物联网应用
- 日志记录
- SSD 之FTL转换层
- java在命令行中编译代码出现 错误: 编码GBK的不可映射字符
- [Log4j] 配置Log4j
- Spring Cloud Swagger(接口管理)
- linux基础操作命令
- 大数据系统与大规模数据分析 之 作业二
- 【Python初学笔记】set()字符串后为什么消除重复元素?
- java基础内容每日笔记_day01
- SpringMVC框架前端传递List限制大小256问题
- CentOS7 编译安装Memcached、设置自启动、php7编译安装Memcached
- Spring Cloud Zuul (服务网关)
- 百度地图 Android 设置 InfoWindow 不同缩放级别均能居中(自定义偏移量)