0

我正在使用 Apiary 来模拟一个新的 API。

我试图避免一遍又一遍地写出所有 JSON 响应。如果我使用 a + Attributes(user)then 执行此操作，它将在机器面板中自动生成一堆属性块，这在我看来非常令人困惑（尤其是当您有多个响应时）。

如果您手动写出 JSON 请求/响应块，生成的文档看起来会更好。

有没有办法将请求/响应对象存储为数据结构？也许是一个模型？

我希望能够做这样的事情：

## Users [/auth]
A user object contains the these attributes.

+ Attributes (user) <!-- I like this here -->

### Refresh a token for a user [POST /auth/refresh]

+ Request (application/json)
    + Headers

            Authorization: Bearer jsonWebToken


+ Response 200 (application/json)          
    + Body

            {
                "data": [
                    (user) <!-- I wish this was the user data structure as JSON -->
                ],
                "meta": {
                    "access_token": "jsonWebToken",
                    "token_type": "Bearer",
                    "expires_in": 3600
                }
            }



# Data Structures

## user (object)
+ id: 123 (number)
+ email: drew@funkhaus.us

注意：该user对象在现实生活中有 30 个属性长。

4

1 回答 1

0

不幸的是，这不是受支持的场景，您不能将数据结构放入您的JSON有效负载中。

因此，如果我理解正确 - 使用 Attributes 很好，但您希望将它们隐藏在文档中。你能确认一下吗？

于 2016-09-17T11:36:34.120 回答