【发布时间】：2020-10-20 11:38:22
【问题描述】：
我们有一个中等规模的应用程序（100 多个 SQL 表），我们经常需要将它与合作伙伴 API 集成（我们的系统作为客户端/消费者）。设计这种集成的过程并非易事：
- 我们经常需要将数据库中的列映射到合作伙伴 API 请求中的字段。
- 对合作伙伴 API 的请求中的某些字段必须是常量或有条件的
- 在极少数情况下，一个 API 响应的输出会成为另一个 API 请求的输入
网络上有许多资源可以记录 REST API - 有特定的格式（Swagger、RAML 等）。这些格式允许有效地生成客户端代码和人类可读的文档。但是，这些格式对于描述您的应用程序如何与 API 集成并不是很有帮助。我们创建冗长的 Microsoft Word 文档，其中包含或多或少的合作伙伴 API 方法的副本，其中包含每个单独的字段应如何使用的 cmets。这样的解决方案似乎不是最理想的。
搜索更好的选项并没有产生很多结果，即 Swaggerhub 似乎具有“cmets”功能，似乎针对上述问题，仅此而已。
问题：是否有一些工具、格式、工作流程、想法等有助于设计和记录上述 API 集成？
【问题讨论】：
标签： api rest workflow integration