1

我在 Apiary 中定义了一个 API 合同，并且我正在使用资源模型语法来启用有效负载的重用。

Apiary 呈现的文档仅显示模型名称（例如，响应 200 返回一个 [Foo][]） - 没有任何关于 Foo 是什么的进一步详细信息，或任何查看 Foo 模型中属性的链接。

给定一个模型，我如何在渲染的文档中查看它的属性？

更新
合同的相关部分如下：

### Manipulating a specific Organisation [/organisations/{id}]
Operations to retrieve and update a specific Organisation.

+ Parameters

    + id (required, guid, `F339ADA5-E836-40FE-8E90-BEF06892762E`) ... The guid Organisation `id`.

+ Model (application/json)

    + Headers

            Link : <http://foobar.com/organisations/F339ADA5-E836-40FE-8E90-BEF06892762E>;rel="self"

    + Body

            {
                "id" : "F339ADA5-E836-40FE-8E90-BEF06892762E",
                "name" : "joe's gardening supplies"
            }

### Retrieve an Organisation [GET]

+ Response 200

        [Organisation][]

### Update an Organisation [PATCH]

+ Request

        [Organisation][]

+ Response 204
4

2 回答 2

3

除非您提供示例，否则这只是猜测，但我的第一个猜测是错误的缩进级别。示例蓝图可能如下所示：

FORMAT: 1A
HOST: http://www.google.com

# Model Example
Notes API is a *short texts saving* service similar to its physical paper presence on your table.

# Group Notes
Notes related resources of the **Notes API**

## Note [/notes/{id}]
A single Note object with all its details

+ Parameters
    + id (required, number, `1`) ... Numeric `id` of the Note to perform action with. Has example value.

+ Model

    + Header

            X-My-Header: The Value

    + Body

            { "id": 2, "title": "Pick-up posters from post-office" }

### Retrieve a Note [GET]
+ Response 200 (application/json)

    [Note][]

### Remove a Note [DELETE]
+ Response 204

上面的代码生成了这个文档，其中模型被正确地合并到它被引用的地方（以及支持这种引用的地方 - 即有效载荷的定义）。

有时在 GitHub 上阅读 Apiary 文档的原始版本会很有帮助，因为这样更容易找到正确、准确的格式。

于 2014-06-23T07:51:39.760 回答
1

好的，通过比较两个示例，我已经解决了。

在我的合同中，模型参考

[Organisation][]

缩进了两个制表符而不是一个。:S

这是一个非常容易犯的错误——如果 Apiary 为模型参考标记了不正确的缩进级别，将会很有帮助。

于 2014-06-24T03:08:26.027 回答