Файл Swagger с предупреждением

Файл Swagger работает, как и ожидалось, с предупреждением.

{
  'swagger': "2.0",
  "info": {
    "version": "3.0",
    "title": "Sample Service",
  },
  "schemes": [ "http" ],
  "host": "sampleservice.azurewebsites.net",
  "paths": {
    "/": {
      "post": {
        "summary": "Sample service",
        "description": "sample service",
        "parameters": [
          {
            "name": "Input",
            "in": "body",
            "description": "valid input",

            "schema": {
              "type": "object",
              "properties": {
                "MainAttr-1": {
                  "required": [ "Attr-1" ],
                  "type": "object",
                  "properties": {
                    "Attr-1": {
                      "description": "Attr-1",
                      "required": true,
                      "type": "string"
                    },
                    "Attr-2": {
                      "description": "Attr-2",
                      "required": false,
                      "type": "string"
                    },
                    "Attr-3": {
                      "description": "Attr-3",
                      "required": false,
                      "type": "boolean"
                    },
                    "Attr-4": {
                      "description": "Attr-4",
                      "required": false,
                      "type": "boolean"
                    },
                    "Attr-5": {
                      "description": "Attr-5",
                      "required": false,
                      "type": "string"
                    }
                  }
                },
                "MainAttr-2": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [ "Attr-1", "Attr-3", "Attr-5", "Attr-8" ],
                    "properties": {
                      "Attr-1": {
                        "description": "Attr-1",
                        "required": true,
                        "type": "string"
                      },
                      "Attr-2": {
                        "description": "Attr-2",
                        "required": false,
                        "type": "string"
                      },
                      "Attr-3": {
                        "description": "Attr-3",
                        "required": true,
                        "type": "boolean"
                      },
                      "Attr-4": {
                        "description": "Attr-4",
                        "required": false,
                        "type": "boolean"
                      },
                      "Attr-5": {
                        "description": "Attr-5",
                        "required": true,
                        "type": "string"
                      },

                      "Attr-6": {
                        "description": "Attr-6",
                        "required": false,
                        "type": "string"
                      },
                      "Attr-7": {
                        "description": "Attr-7",
                        "required": false,
                        "type": "string"
                      },
                      "Attr-8": {
                        "description": "Attr-8",
                        "required": true,
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "success"
          }
        }
      }
    }
  }
}

введите здесь описание изображения

Проблема-1) Предупреждение должно быть удалено

Проблема-2) Attr-3 в «MainAttr-2» является атрибутом логического типа и является обязательным. Но когда я выбираю «ложь» из раскрывающегося списка, это рассматривается как недопустимый ввод. Он рассматривает только «истину» как допустимый ввод. (Любой логический атрибут, который требуется, ведет себя так)

Из-за этого предупреждения я не могу доставить код.

Заранее спасибо.


person Ganesh    schedule 07.12.2016    source источник


Ответы (1)


  1. В начале измените 'swagger' на "swagger". JSON требует двойных кавычек вокруг строк.

  2. Уберите лишнюю запятую в конце:

    "title": "Sample Service",
    
  3. Удалите атрибут required из ВСЕХ определений свойств (от Attr-1 до Attr-8) и вместо этого используйте список required на уровне объекта (под MainAttr-1 и MainAttr-2).

            "MainAttr-1": {
              "required": [ "Attr-1" ],    <-- list the required properties in this array
              "type": "object",
              "properties": {
                "Attr-1": {
                  "description": "Attr-1",
                  "required": true,        <-- remove this 
                  "type": "string"
                },
    

В остальном ваша спецификация в порядке.

person Helen    schedule 07.12.2016
comment
Спасибо за ответ. Тем не менее я получаю такое же предупреждение - person Ganesh; 08.12.2016
comment
Обязательно удалите атрибут required из ВСЕХ свойств (от Attr-1 до Attr-8) и оставьте его только на уровне объекта (списки под MainAttr-1 и MainAttr-2). - person Helen; 08.12.2016
comment
Спасибо, Хелен. Проблема исправлена - person Ganesh; 08.12.2016