大禹安全 REST API 规范

简介

REST API 规范作为一种设计原则，鼓励应用程序开发人员通过 RESTful HTTP 接口为他们提供可访问的资源。为了在遵循大禹安全 REST API 准则的平台上为开发人员提供最顺畅的体验，REST API 应遵循一致的设计准则，以便使用它们变得简单直观。

本文档建立了大禹安全 REST API 应遵循的准则，以便一致地开发 RESTful 接口。一致性的接口规范可以使团队利用通用代码，模式，文档和设计决策。

这些准则旨在实现以下目标：

• 为大禹安全中的所有 API 定义一致的实践和模式。
• 尽可能地遵守业内普遍接受的 REST / HTTP 最佳实践。
• 通过 REST 接口轻松访问所有应用程序开发人员开发的服务。
• 允许服务开发人员利用其他服务或工具测试和记录定义的 REST API。
• 允许合作伙伴（例如，非大禹安全实体）将这些准则用于他们自己的 REST API 设计。

准则

适用对象

产品经理、项目经理、架构师、服务端开发工程师、Web 服务端开发工程师、前端开发工程师、测试工程师

设计流程

设计指南建议在设计面向资源的 API 时采取以下步骤（更多细节将在下面的特定部分中介绍）：

• 确定 API 提供的资源类型。

• 确定资源之间的关系。

• 根据类型和关系确定资源名称方案。

• 确定资源架构。

• 将最小的方法集附加到资源。

本文档使用的语言

本文档使用的要求级别关键字（“必须”，“必须不”， “应该”， “不应该”， “可以”）将按 RFC 2119 中的描述进行解释。

在本文档中，这些关键字使用粗体显示。