API藍圖 - 使用數據結構作爲響應，無屬性

我正在使用Apiary模擬出一個新的API。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: [email protected]

注：user對象是30個屬性的長在現實生活中。

來源

2016-09-16 Drew Baker

不幸的是，這不是一個受支持的情況，你不能但數據結構到你的JSON有效載荷。

所以，如果我理解正確 - 使用屬性是好的，但你想隱藏在文檔中。你能證實嗎？

來源

2016-09-17 11:36:34 Vincenzo

是的，只要它不在機器面板中生成塊（藍色最右邊的塊），我就可以使用屬性。 –

然後，您可能想在Apiary本身中打開一個問題。只需使用您的帳戶連接到網站並使用內部聊天提交問題 - 我們會盡力處理。 – Vincenzo

API藍圖 - 使用數據結構作爲響應，無屬性

回答

相關問題