问题描述
我希望熟悉 Amazon Connect API。我已经看过下面的参考资料,但它对我来说很难使用,因为导航是按操作而不是资源排序的按字母顺序排列的端点的平面列表。值得注意的是,端点按字母顺序排列,以“删除”、“获取”、“列表”、“更新”等开头,但最好将它们按资源分组。
我想重新组织文档,这可以通过编辑 OpenAPI 或其他 API 规范并为每个操作添加标签来完成。我查看了参考资料并进行了一些搜索,但没有成功。
我正在使用以下 API 参考:
https://docs.aws.amazon.com/connect/latest/APIReference
任何其他规范格式,如 RAML 或专有格式也可以。例如,Google 提供了自己的“Google discovery Format”,可以转换为 OpenAPI。 https://googleapis.github.io/ 中提到了以下内容。
开放API
我们建议使用 OpenAPI 和基于 OpenAPI 的工具来处理 Google 的 REST API。已发布多个用于将 Google discovery 格式转换为 OpenAPI 的工具:
- google-discovery-to-swagger,一个 MIT 许可的开源脚本,用于将 Google discovery 格式转换为 Swagger 2.0。
- API Spec Converter,LucyBot 的在线转换器。
- 来自 APIMatic 的 API 转换器。
Google 的 OpenAPI 工具包括 gnostic,它是 OpenAPI 工具的前端,可读取 OpenAPI 描述,将它们置于高效的二进制表示中,并允许使用任何具有协议的编程语言轻松编写高效的插件和独立工具缓冲区支持。
是否有适用于该 API 的 OpenAPI 或其他规范?如果有,我想用标签更新它,然后以更易于使用的格式呈现它。
更新:Aossey 指出亚马逊没有为其 API 发布 OpenAPI 规范。为了解决这个问题,我已经开始在下面的 repo 中收集一些信息,可能会产生一个 OpenAPI 规范。随意贡献。
https://github.com/grokify/amazon-api-specs/blob/master/connect/endpoints.csv
解决方法
简短的回答是否定的,这些 API 没有 OpenAPI 规范。
这些函数(在您链接的文档中列出)在 AWS SDK 和 AWS CLI 中实现。虽然存在底层 HTTP 端点,但它们并不容易以您最有可能寻找的方式使用。 SDK 和 CLI 负责身份验证/授权(通过 IAM service)并为您请求签名,如果您要直接利用端点,则必须自己实现。