我正在使用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个属性。
不幸的是,这不是一个受支持的场景,您不能将数据结构放入JSON
有效负载中。
所以,如果我理解正确-使用属性是好的,但你想隐藏他们的文档。你能否证实?