Swagger HashMap тип собственности

Question

Есть ли способ определить тип HashMap или Generic Object в разделе моделей? У меня есть служба REST, которая возвращает продукты, и эти продукты могут иметь разные варианты. Свойство options - это, в основном, HashMap, где id - это имя параметра, а его значение - значение параметра.

Answer 1

Да, это возможно.

В OpenAPI (. FKA Кураж) 2,0 и 3,0, HashMap лучше всегда <string, something> карта:

• Ключ всегда является строкой и не должны быть определены.
• Тип значения - это то, что вы хотите, и определяется с помощью additionalProperties.

Допустим, вы хотите, чтобы описать <string, string> HashMap, как этот:

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

Соответствующее определение OpenAPI 2,0 будет:

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

В OpenAPI 3.0 определение будет:

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

<string, object> HashMap как этот

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

будет определяться таким образом, в 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.