API 重构是通过观察进出该 API 的流量来构建 API 规范。如果做得好,API 重构可让您了解微服务使用的 API,并使您能够评估 API 安全风险。构建规范后,相同的工具可以将运行时流量与规范进行比较以检测偏差。
API 规范的关键组件包括:
- 参数检测(路径、头参数、查询参数、请求体参数和cookies)
- 对象引用
- 文件传输
- 安全定义
- Optic — 一种可扩展的、与语言无关的开源工具。它对于在部署之前记录、审查和批准 API 很有用。
- SwaggerHub — 一种将 API 流量转换为 OAS 的流行工具。
- CloudVector API Shark — 可以监控多服务环境并从运行时流量生成 OAS 规范。
- Imvision — 适用于多服务环境的强大 API 可见性和文档工具。
APIClarity提供了一个强大的、开源的、可扩展的多服务 API 可见性和重建解决方案。它使用服务网格框架轻松集成到现有环境中。使用 APIClarity,开发人员可以导入 API 规范或根据观察重建 API 规范。开发人员还可以实时监控所有 API 流量,无需更改代码或工作负载。
作为一个开源项目,APIClarity 不断发展并接受来自开发者社区的贡献。
工作原理:
- APIClarity 部署在现有的 K8s 集群中
- API 流量从集群中的 pod 镜像到 APIClarity 的 OpenAPI 规范引擎
- 规范引擎监控内部和外部流量并记录 API 事件
- APIClarity根据API流量学习规范,构建API规范
- 用户审查、编辑和批准规范
- APIClarity 会提醒用户注意安全问题或观察到的 API 与批准的 API 规范之间是否存在任何偏差