Swagger HashMap 속성 형식

Question

HashMap 또는 Generic Object 형식을 모델 섹션에서 정의 할 수있는 방법이 있습니까? 제품을 반품하는 REST 서비스가 있으며 제품에 다른 옵션이있을 수 있습니다. options 프라퍼티는 기본적으로 HashMap이다. id는 옵션 이름이고 그 값은 옵션 값이다.

Answer 1

예 가능합니다.

• 열쇠는 항상 문자열이고 정의 할 필요가 없습니다 OpenAPI를에서

  (. FKA 자신감은) 2.0 및 3.0, 해시 맵은 항상 <string, something> 맵입니다.

• 값 유형은 원하는 값이며 additionalProperties으로 정의됩니다.

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

  대응하는 OpenAPI를 2.0 정의됩니다 :

  이

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

  는 OpenAPI를 3.0에서 정의가 될 것입니다 :

의 당신이 하나의 같은 <string, string> 해시 맵을 설명하고 싶은 말은하자

01 이

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

같은 235, <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.