Swagger HashMap proprietà type

Question

C'è un modo per definire un HashMap o di tipo generico oggetto nella sezione modelli? Ho un servizio REST che restituisce prodotti e tali prodotti possono avere opzioni diverse. La proprietà options è fondamentalmente una HashMap, dove id è il nome dell'opzione e il suo valore è il valore dell'opzione.

Answer 1

sì è possibile.

In OpenAPI (. Fka Swagger) 2.0 e 3.0, una HashMap è sempre una mappa <string, something>:

• La chiave è sempre una stringa e non hanno bisogno di essere definito.
• Il tipo di valore è quello che vuoi e viene definito con additionalProperties.

Diciamo che si vuole descrivere un <string, string> hashmap come questo:

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

La definizione OpenAPI 2.0 corrispondente sarà:

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

Nel OpenAPI 3.0 la definizione sarà:

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

Un <string, object> hashmap come questo

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

sarà definito in questo modo nel OpenAPI 2.0:

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

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

e in OpenAPI 3.0:

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

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

Ho appena coperto questo in profondità in part 4 of my OpenAPI (fka Swagger tutorial).

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