Question

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

我试图避免不得不一遍又一遍地写出所有JSON响应。如果我使用+ Attributes(user)执行此操作，那么它将在机器面板中自动生成一堆属性块，这在我的脑海中非常混乱（特别是当您有多个响应时）。

如果您手动写出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个属性。

Answer 1

不幸的是，这不是受支持的方案，但您不能将数据结构添加到JSON个有效负载中。

因此，如果我理解正确 - 使用属性很好但你想在文档中隐藏它们。你能证实吗？

API蓝图 - 在没有属性的情况下使用Data Strucutres作为响应

1 个答案: