Apiary：JSON応答フィールドがどのようなものであるかを文書化することは可能ですか？

Question

実際のJSONフィールド自体がどのようなものを表すものを文書化したいです。

GETステートメントとパラメータを文書化しましたが、これはユーザーに提供するための完全な資料を作成しません。

だから、以下の例では、 "otherfields"についてのコメントをどのように追加しますか。これはサポートされていますか？それとも私は他の場所にコンパニオンドキュメントを作る必要があります。

## View Applications [/cat{?sort}{&order}{&page}]
### List all Applications 
### Get List of Applications [GET]
+ Parameters
    + sort (optional, string) ... `sort` parameter is used to specify which criteria to use for sorting. One of the following strings may be used: 
    `"NAME", 
    "RATING", "QUALITY" ,
    "RISKLEVEL", `

    + order (optional, string) ... `order` parameter is used to specify which order to use if sorting is used. One of the following strings may be used: 
    `"ASC", 
    "DESC"`

    + page (optional, int ) ... `page` parameter is used to request subsequent catalog pages.


+ Response 200 (application/json)

                {
            "Catalog" : {
                "Page" : 0,
                "Count" : 6,
                "Applications" : [{
                        "UID" : "6882e96a-5da1-11e3-1111-3f24f45df3ad"
                        "OtherFields: ""
               }]
               }}

.

Answer 1

Update： mson構文を使用して、属性のベータ版を転校しました。

元のペイロードは

として説明することができます

### Get List of Applications [GET]

+ Response 200 (application/json)

    + Attributes
        + Catalog (object)
            + Page: 0 (number) - Number of the page
            + Count: 6 (number) - Count of *Lorem Ipsum*
            + Applications (array) - Some array of something
                + (object)
                    + UID: `6882e96a-5da1-11e3-1111-3f24f45df3ad`
                    + OtherFields

    + Body 

            {
                "Catalog" : {
                    "Page" : 0,
                    "Count" : 6,
                    "Applications" : [{
                        "UID" : "6882e96a-5da1-11e3-1111-3f24f45df3ad"
                        "OtherFields": ""
                    }]
                }
            }

.

注記の明示的なJSONは冗長であり、それを完全にスキップすることができます。API BluePrintの仕様 - 属性その他の詳細は

Answer 2

私はそれがまだサポートされているとは思わない。

私のプロジェクトでは、テーブルをGET Request Lineの上の上の説明で置くことで解決しました。あなたの場合には、次のようになります。

### List all Applications 

| Field                            | Description               |
|----------------------------------|---------------------------|
| Catalog.Applications.OtherFields | Documentation goes here.. |

### Get List of Applications [GET]

.

MarkDown構文でテーブルを作成するのに役立ちます markdownテーブルGenerator 。

テーブルジェネレータを使用すると、次回のテーブルをファイルに保存することができるようにしてください。