Swagger HashMapプロパティタイプ

Question

モデルセクションにHashMapまたは汎用オブジェクトタイプを定義する方法はありますか？ 私は製品を返すRESTサービスを持っており、それらの製品には異なるオプションがあります。 optionsプロパティは基本的にHashMapです。ここで、idはオプション名で、その値はオプション値です。

Answer 1

はい、可能です。 OpenAPIので

（。FKA SWAGGER）2.0および3.0、ハッシュマップは常に<string, something>マップです：

• キーは常に文字列であると定義する必要はありません。
• 値の種類は任意で、additionalPropertiesで定義されています。

のは、あなたがこのいずれかのよう<string, string>ハッシュマップを記述したいとしましょう：

{ 
    "key1": "value1", 
    "key2": "value2" 
} 

対応OpenAPIの2.0定義は次のようになります。OpenAPIを3.0に

definitions: 
    StringStringMap: 
    type: object 
    additionalProperties: 
     type: string 

の定義は次のようになります。

components: 
    schemas: 
    StringStringMap: 
     type: object 
     additionalProperties: 
     type: string 

01この

{ 
    "key1": {"someData": "data", "someOtherData": true}, 
    "key2": {"someData": "data2", "someOtherData": false} 
} 

よう <string, object>ハッシュマップは、OpenAPIを2.0にこのように定義されます。

definitions: 
    ComplexObject: 
    type: object 
    properties: 
     someData: 
     type: string 
     someOtherData: 
     type: boolean 

    StringObjectMap: 
    type: object 
    additionalProperties: 
     $ref: "#/definitions/ComplexObject" 

とOpenAPIの3.0で：

components: 
    schemas: 
    ComplexObject: 
     type: object 
     properties: 
     someData: 
      type: string 
     someOtherData: 
      type: boolean 

    StringObjectMap: 
     type: object 
     additionalProperties: 
     $ref: "#/definitions/ComplexObject" 

私は深さでこれを単に紹介してきましたpart 4 of my OpenAPI (fka Swagger tutorial)にあります。

OpenAPI (fka. Swagger) specification explains briefly this too。