orchestrator
2024.10
true
Orchestrator API 指南
读取我
重要提示:
我们计划将 Orchestrator Swagger 版本升级到 Swagger 3.0。目前,Orchestrator API 是使用 Swagger 2.0 定义的。
不必担心与现有 API 客户端的向后兼容性:我们将确保 API 保持兼容。
我们建议使用您以前的客户端,因为我们的请求结构向后兼容,因此 JSON 更改不会改变它们。
Swagger 3.0 更新后,所有基于新 JSON 定义重新生成的 API 客户端都必须重新调整。
如果您计划将我们的 API 与客户端集成,则需要注意 Swagger 定义、JSON 架构或 API 端点可能发生的更新和更改。
下表提供了有关 Swagger 更改的信息和建议。 如果您还有其他问题,请 联系我们的支持团队。
- Swagger JSON 文档中表示的 JSON API 描述可以随时更改。 但是,它将描述相同的基础 API,以确保向后兼容性。
- Swagger 界面和相应的 JSON 是根据当前端点生成的,并且我们始终发布最新版本。 为确保向后兼容性,我们支持相同的请求结构。
- 作为运行时生成的 API 客户端的替代方法,请使用固定时或编译时 API 客户端。 这样做可以减少依赖关系,并防止在 API 或 Swagger 定义发生更改时进行重大自动化更新。
- 标记为已弃用的项目在限定时间内可用,之后将从 Swagger 定义和 JSON API 中删除这些项目。
- 每当某些 API 在内部发生更改时,都会发布新的 Swagger API 版本。 API 版本号不会影响客户端 API 的使用。 我们不建议依赖 API 版本控制。