22

我们正在研究使用 API 蓝图。在某些情况下，我们希望一个请求返回正确的响应，而另一个请求返回一个“错误”响应，例如 a 400 bad request，以便其他开发人员可以使用 apiary.io 上的模拟 API 处理这两种类型的响应并在他们的应用。

我在下面创建了一个完全任意的示例，

## Thing [/thing/{id}]
Gets a thing but the thing id must be a prime number!


+ Parameters
    + id (string) ... ID of the thing, a prime number!

+ Model (application/json)

    The thing itself.

    + Body

            {
                "description": "It is green"
            }

### Retrieve a Single Gist [GET]
+ Response 200

    [Gist][]

现在我想以某种方式添加对/thing/40

+ Response 400
    {  "error" : "Invalid request" }

但我不确定如何使用 API 蓝图做到这一点。这在 apiary.io 上的“旧”样式下是可以实现的，但我们想继续使用新的语法

4

2 回答 2

12

要记录多个响应，只需在Response 200类似之后添加它：

## Thing [/thing/{id}]
Gets a thing but the thing id must be a prime number!

+ Parameters
    + id (string) ... ID of the thing, a prime number!

+ Model (application/json)

    The thing itself.

    + Body

            {
                "description": "It is green"
            }

### Retrieve a Single Gist [GET]
+ Response 200

    [Thing][]

+ Response 400 (application/json)

        {  "error" : "Invalid request" }

请注意，目前没有专门的语法来讨论条件（返回此响应时）。您可以随意讨论它，例如：

+ Response 400 (application/json)

    This response is returned when no `Thing` for given `id` exists.

    + Body

如果您使用 Apiary 模拟，请记住，默认情况下会返回列出的第一个响应，除非您另有说明，使用首选 HTTP 标头。

于 2014-01-22T14:08:09.440 回答
1

您可以在资源的通用响应之后使用模板并指定特定用例，请参见示例：

预订 [/reservation/{reservation_key}]

Reservation 对象具有以下属性：

  • 房间号
  • reserved_at - 发布问题的 ISO8601 日期。

  • booker_details - 一个 Booker 对象。

  • 参数

    • reservation_key (required, text, 1) ... 保留键 ash

查看预订详情 [GET]

  • 响应 200（应用程序/json）

    {
    "room_number": 55,
    "reserved_at": "2014-11-11T08:40:51.620Z",
    "booker_details": 
        {
            "name": "Jon",
            "last_name": "Doe",
        }
}

预订 [/reservation/notarealreservation123]

使用不存在的预订（请notarealreservation123在假货中使用）返回未找到

于 2015-04-24T14:00:15.917 回答