OpenStack API 特别兴趣组

使命宣言

通过将 OpenStack API 统一到一致且务实的 RESTful 设计中，来改善 API 使用者的开发体验。工作组创建所有 OpenStack 项目在新开发中应遵循的指南，并促进新 API 以及现有 API 未来版本的统一。

序言

本文档包含 OpenStack 项目 API 的指南和规则，包括有关 API 一致性、命名约定和最佳实践建议的指南和拟议规则。

如果您想与 API 特别兴趣组联系，请访问维基：https://wiki.openstack.org/wiki/API_Special_Interest_Group

如果您有兴趣为本文档做出贡献，git 仓库可在：http://opendev.org/openstack/api-sig/

OpenStack 代码和审查提交流程在：https://docs.openstack.org/infra/manual/developers.html

警告

API 特别兴趣组的这些文档主要侧重于为基于 JSON 的 API 提供建议和指南。虽然其他表示形式在 OpenStack 生态系统中占有一席之地，但它们提出了多样化的挑战和边缘情况，尤其是在大型和/或二进制请求和响应体的情况下，因此不可能提供完整的指导。

注意

当此指南不完整或模棱两可时，请参考 HTTP RFC—RFC 7230，RFC 7231，RFC 7232，RFC 7233，RFC 7234，和 RFC 7235—作为最终权威。有关在 API 中有效使用 HTTP 的建议，请参阅 使用 HTTP 构建协议。

指南

以下主题与工作组及其流程相关

这些主题是 OpenStack 社区批准并由工作组发布的 API 指南