本文给大家介绍的内容是系统集成服务集成交互技术:REST服务集成,Swagger接口文档规范;
Swagger接口文档规范
上一节中我们使用REST标准描述了一个使用订单服务的API文档。
然而API文档的维护,给技术人员带来了额外的工作量。另外,技术文档人员对API的理解的偏差,也给API文档的可操作性带来了问题。对于后端人员,Swagger为我们提供了一个在线的REST API文档,可以提供给不同团队,加速开发过程,也提供了更加便携的基于标准文档的交互方式。
Swagger API标准
Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。Swagger的目标是定义标准的、和语言无关的接口,让人和计算机无须访问源码、文档或进行网络流量监测就可以发现和理解服务的能力。
Swagger规范定义了一组描述一个API所需的文件格式,类似于描述Web服务的WSDL。通过Swagger进行REST API的正确定义,用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与底层编程所实现的接口类似,Swagger消除了调用服务时产生的理解差异。
集成Swagger的步骤
1.导入Maven依赖
2.实现Swagger配置类
注解说明:
● @EnableSwagger2:Swagger2启动注解。
● @Configuration:声明这是一个配置类。
3.配置接口的API参数描述
网关集成Swagger
Swagger是一个API文档生成工具,在微服务架构中,API网关可以起到聚合后端众多微服务的作用,同时可以利用微服务网关集成Swagger生成所有微服务的接口文档。下面是基于网关Zuul集成Swagger的文档示例。
本文给大家讲解的内容是系统集成服务集成交互技术:REST服务集成,Swagger接口文档规范
- 下篇文章给大家讲解的内容是系统集成服务集成交互技术:REST服务集成,JAX-RS提供REST服务
- 觉得文章不错的朋友可以转发此文关注小编;
- 感谢大家的支持!
- 本文就是愿天堂没有BUG给大家分享的内容,大家有收获的话可以分享下,想学习更多的话可以到微信公众号里找我,我等你哦。