Api-blueprint: अशक्त प्रकार विधि घोषणा के भीतर काम नहीं करता

हाय @danilvalov ,

एपियरी में विशेषताओं के प्रतिपादन में सुधार के लिए एक बीटा है, जिसमें अशक्तता के लिए समर्थन शामिल है। आप बीटा के बारे में अधिक जानकारी https://github.com/apiaryio/api-blueprint/issues/191#issuecomment -178044764 पर और इसमें शामिल होने के तरीके के बारे में जान सकते हैं।

सादर,

केली

मैं केवल यह बताना चाहता हूं कि इसे अब एपीरी (बीटा के बिना) में तैनात कर दिया गया है।

एक उदाहरण के रूप में, आप निम्न की तरह अशक्त का उपयोग कर सकते हैं:

+ Response 200 (application/json)
    + Attributes
        + example1 (string, optional, nullable) - An example optional nullable string
        + example2: value (string, optional, nullable) - An example optional nullable string with a sample value

जहां इसके परिणामस्वरूप निम्नलिखित का एक उदाहरण पेलोड होगा:

{
  "example1": null,
  "example2": "value"
}

निम्नलिखित JSON स्कीमा के साथ:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "example1": {
      "type": [
        "string",
        "null"
      ],
      "description": "An example optional nullable string"
    },
    "example2": {
      "type": [
        "string",
        "null"
      ],
      "description": "An example optional nullable string with a sample value"
    }
  }
}

एपीरी में विशेषताओं की तालिका में

यह अब दिखाई दे रहा है, ApiaryUI में :