5.2. OpenAPI 文档示例： Petstore API

要从原始源读取规格，请参阅 OpenAPI 规格。

在 OAS 网站上，定义了 API 的 OpenAPI 文档的多个示例。如果您想通过示例了解，可以按照 OAS API 团队的 Petstore API 示例进行操作。

Petstore API 是一个极其简单的 API。它被称为学习工具，不适用于生产环境。

Petstore API 方法

Petstore API 由 4 种方法组成：

  • GET /api/pets - 返回系统中的所有片断
  • POST /api/pets - 在存储中创建新的片断
  • GET /api/pets/{id} - 基于单个 ID 返回 pet
  • DELETE /api/pets/{id} - 根据 ID 删除一个片断

Petstore API 与 3scale 集成，因此您必须添加额外的参数进行验证。例如，通过用户密钥身份验证方法，API 使用者必须将 user key 参数放在各个请求的标头中。有关其他验证方法的详情，请参考验证模式。

用户密钥参数

user_key: {user_key}

user_key 将由 API 用户在其请求中的 API 发送到您的 API。API 用户将获得 3scale 管理员开发人员门户的密钥。在收到密钥时，3scale 管理员必须使用 Service Management API 对 3scale 执行授权检查。

OpenAPI 规格的更多信息

对于 API 用户，在 cURL 调用中代表的 API 文档类似如下： 

curl -X GET "http://example.com/api/pets?tags=TAGS&limit=LIMIT" -H "user_key: {user_key}"
curl -X POST "http://example.com/api/pets" -H "user_key: {user_key}" -d "{ "name": "NAME", "tag": "TAG", "id": ID }"
curl -X GET "http://example.com/api/pets/{id}" -H "user_key: {user_key}"
curl -X DELETE "http://example.com/api/pets/{id}" -H "user_key: {user_key}"