अकड़ में एक वस्तु परिभाषा यह है कि उसके गुण

Question

नीचे दिए गए उदाहरण का जिक्र करते हुए एक के रूप में एक सरणी शामिल हैं का एक उदाहरण प्रदान करने के लिए कैसे, मैं अपनी परिभाषा में NamedElementArray का एक उदाहरण प्रदान करना चाहते हैं। elements विशेषता के लिए इसे NamedElement की सरणी का उदाहरण दिखाने की आवश्यकता होगी।

मैं यह कैसे कर सकता हूं? मैं swagger विनिर्देश में यह कैसे करना है के बारे में विवरण नहीं मिल सकता है।

swagger: '2.0' 

info: 
    version: "0.0.0" 
    title: Example 

definitions: 
    Identifier: 
    type: string 
    format: uuid 
    NamedElement: 
    type: object 
    properties: 
     name: 
     type: string 
     identifier: 
     $ref: "#/definitions/Identifier" 
    required: 
    - name 
    - identifier 
    example: 
     name: Identifier1 
     identifier: ab804529-11d0-4781-a49a-3bbbc40243df 
    NamedElementArray: 
    type: object 
    properties: 
     name: 
     type: string 
     elements: 
     type: array 
     minLength: 0 
     items: 
      $ref: "#/definitions/NamedElement" 
    required: 
    - name 
    - elements 
    example: 
     name: Fred 
     elements: 

paths: 
    /elements/{name}: 
    get: 
     description: | 
     Gets `NamedElement` objects, based on the **name** query param. 
     parameters: 
     - 
      name: name 
      in: path 
      description: Name of element array to return 
      required: true 
      type: string 
     responses: 
     200: 
      description: Returns a named element array 
      schema: 
      $ref: "#/definitions/NamedElementArray" 
     default: 
      description: Return nothing 

Answer 1

आप उच्च स्तर उदाहरण और निम्न स्तर लोगों के बीच चयन करने के लिए है। स्वैगर यूआई में, उच्च स्तर के उदाहरण स्थानीय से पहले हैं।

Identifier: 
    type: string 
    format: uuid 
    example: Local UUID example 

NamedElement: 
    type: object 
    properties: 
     name: 
      type: string 
      example: Local identifier example 
     identifier: 
      $ref: "#/definitions/Identifier" 
     required: 
      - name 
      - identifier 

NamedElementArray: 
    type: object 
    properties: 
     name: 
      type: string 
      example: Local name example 
     elements: 
      type: array 
      minLength: 0 
      items: 
       $ref: "#/definitions/NamedElement" 
    required: 
     - name 
     - elements 

उस मामले उदाहरण स्वैगर यूआई में इस तरह दिखेगा में:

पूर्ण उदाहरण Swagger Hub

पर उपलब्ध आप प्रत्येक संपत्ति (निम्न स्तर) पर एक उदाहरण परिभाषित कर सकते हैं

{ 
    "name": "Local name example", 
    "elements": [ 
    { 
     "name": "Local identifier example", 
     "identifier": "Local UUID example" 
    } 
    ] 
} 

लेकिन क्या आप भी है जैसे आप +०१२३७८७२९३११ पर अपने उदाहरण में किया था उच्च स्तर पर एक पूर्ण उदाहरण दे सकता हूँ:

NamedElementArray: 
    type: object 
    properties: 
     name: 
      type: string 
     elements: 
      type: array 
      minLength: 0 
      items: 
       $ref: "#/definitions/NamedElement" 
    required: 
     - name 
     - elements 
    example: 
     name: Fred 
     elements: 
      - name: Identifier1 
       identifier: ab804529-11d0-4781-a49a-3bbbc40243df 
      - name: Identifier2 
       identifier: zzz4529-11d0-4781-a49a-3bbbc40243df 

उस मामले में उदाहरण स्वैगर यूआई में इस तरह दिखेगा:

{ 
    "name": "Fred", 
    "elements": [ 
    { 
     "name": "Identifier1", 
     "identifier": "ab804529-11d0-4781-a49a-3bbbc40243df" 
    }, 
    { 
     "name": "Identifier2", 
     "identifier": "zzz4529-11d0-4781-a49a-3bbbc40243df" 
    } 
    ] 
}