2017-02-22 5 views
1

現在、私は自分のソフトウェアのスワッガーファイルを作成しようとしています。 今、私はtimeRangeの定義を作成したいと思います。 私の問題は、この配列はこのようになっていることである。名前のない文字列のスワッガー配列

timeRange: { 
    "2016-01-15T09:00:00.000Z", // this is the start date 
    "2017-01-15T09:00:00.000Z" // this is the end date 
} 

どのように私は、箱から出して動作します例の値を作成することができますか? 最小2文字の「文字列の配列」です。

"timeRange": { 
    "type": "array", 
    "items": { 
    "type": "string", 
    "example": "2017-01-15T09:00:00.000Z,2017-01-15T09:00:00.000Z" 
    } 
} 

このように、この例を生成する:それは配列ではなくオブジェクトであるため

"timeRange": [ 
    "2017-01-15T09:00:00.000Z,2017-01-15T09:00:00.000Z" 
] 

この例では、動作しません。 まとめ: 2つの異なる文字列(名前なし)の中に存在する値の例を実現するにはどうすればよいですか。

私を助けることができますように! 乾杯!

答えて

0
timeRange: { 
    "2016-01-15T09:00:00.000Z", // this is the start date 
    "2017-01-15T09:00:00.000Z" // this is the end date 
} 

有効なJSONではありません - 引用符で囲む必要があり、オブジェクト/配列構文は異なるはず"timeRange"

オブジェクト構文{}を使用して、値が命名する特性が必要な場合:最初の例で

"timeRange": [ 
    "2016-01-15T09:00:00.000Z", 
    "2017-01-15T09:00:00.000Z" 
] 


{}[]配列であることが

"timeRange": { 
    "start_date": "2016-01-15T09:00:00.000Z", 
    "end_date": "2017-01-15T09:00:00.000Z" 
} 

そうでない場合timeRangeニーズをオブジェクト)では、Swaggerは次のようになり、それぞれの名前付きプロパティに対して別々のexampleが表示されます:

01あなたは、マルチアイテムの配列であるアレイレベル exampleを指定することができます []配列の場合
"timeRange": { 
    "type": "object", 
    "properties": { 
    "start_date": { 
     "type": "string", 
     "format": "date-time", 
     "example": "2016-01-15T09:00:00.000Z" 
    }, 
    "end_date": { 
     "type": "string", 
     "format": "date-time", 
     "example": "2017-01-15T09:00:00.000Z" 
    } 
    }, 
    "required": ["start_date", "end_date"] 
} 

、:

"timeRange": { 
    "type": "array", 
    "items": { 
    "type": "string", 
    "format": "date-time" 
    }, 
    "example": [ 
    "2016-01-15T09:00:00.000Z", 
    "2017-01-15T09:00:00.000Z" 
    ] 
} 
+0

はどうもありがとうございました。 これはまさに私が探していたものです。 ぼんやりとしたドキュメントを見ていますが、このようなものは見つかりませんでした。 –

関連する問題