2015-05-14 52 views
8

我有一个数据结构定义如下:如何显示嵌套属性定义在Apiary.io

# Data Structures 

## PlayerRank (object) 
Represents the minimum amount of data the the client needs to send to give rank information about a particular Player in a particular Played Game. 
+ playerId (number, required) - NemeStats unique identifier for the Player. 
+ gameRank (number, required) - The corresponding rank of the Player in this Played Game. A rank of 1 means the Player got first place, 2 means second place, and so on. 
+ pointsScored (number, optional) - Integer number of points the Player scored in the Played Game. 

我试图如下在另一个行动定义中使用这个数据结构:

## Create a new Played Game [POST] 
This service will record a new Played Game. 

+ Attributes 
    + gameDefinitionId (number, required) - NemeStats unique identifier for the Game Definition (e.g. Race For the Galaxy's unique Id) of the Played Game. 
    + datePlayed (string, optional) - The date the game was played in yyyy-MM-dd format (e.g. 2015-04-29). 
    + notes (string, optional) - Any notes or comments that the User wants to record about the game for future reference. 
    + playerRanks (array[PlayerRank], required) - A collection of PlayerRank objects specifying the game rank and points scored for each Player. See below table for details. 

我想要发生的是Apiary.io文档,它不仅显示顶级属性的定义,还显示PlayerRank对象的定义。作为试图了解UI的开发人员,我希望看到每个对象和字段的定义,因此我知道如何正确地形成请求。现在它只给出了playerRanks对象的描述:“一组PlayerRank对象,指定每个玩家的游戏等级和得分。”但它不会扩展定义以显示PlayerRank数据结构的所有属性。

任何想法,如果Apiary.io文档可以促进这一点?

回答

4

现在蜂房,API蓝图支持它可以如下面定义例如嵌套对象

+ Attributes (object) 
    + name: iPhone 6/6s (string, required) - Offer Name 
    + price: 10.4 (number) - Offer price 
     can be a number with 2 decimal places, this is the sale price 
    + offer_options (object) 
     + option_name: black (string, required) - offer option name 
     + max_qty: 0 (number) - Purchase limit to this quantity 
2

AFAIK它是一个测试版功能,用户界面尚未完成,请参阅this github issue了解更多信息并预览birght未来。