Как описать конкретный пример Json в Swagger с помощью JSON - PullRequest
Новая
       8

Как описать конкретный пример Json в Swagger с помощью JSON

0 голосов
/ 27 августа 2018

Поскольку сейчас время отпуска, я должен выполнить задачу товарищей по команде.Он использовал чванство для описания программы API I.

Теперь у нас есть намного более сложный метод в нашем API, и у меня возникают проблемы с описанием следующего json: 

{
  "sql": [
    {
      "sql": 1,
      "id": "12345"
    },
    {
      "mysql": 0.75,
      "id": "222222"
    },
    {
      "nosql": 0.75,
      "id": "3333333"
    }
  ],
  "pithon": [
    {
      "python": 0.8333333333333334,
      "id": "4444444"
    }
  ]
}

В нашей документации.Мы используем swagger 2.3, насколько я могу судить по этой строке программы, которую он сказал мне выполнить: java -jar swagger-codegen-cli-2.3.1.jar generate -i swagger.json -l html

И это пример того, что мы делали до сих пор: 

[...],
    "id" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string",
          "description" : "identification"
        },
        "name" : {
          "type" : "string",
          "description" : "name"
        }
      },
      "example" : {
        "id_value" : "5",
        "name_value": "value 1"
      }
    },
 [...]

Я хотел бы знать, как заставить этот более сложный ответ json работать в документации по чванству, так как я следую этому в качестве примера, и чтение документации не делает его более ясным (частично потому, что почтивсе, что я нахожу в YAML, а не в json).

Это то, что я получил до сих пор, но я получаю всевозможные ошибки 

"skills" : {
    "type" : "array",
    "properties" : {
        "skill_input" : {
            "type" : "object",
            "properties" : {
                "skill_possible_name" : {
                    "type" : "array",
                    "properties" : {
                        "type" : "string",
                        "description" : "description 11"
                        }
                    }
                }
            }
        }
    }

Редактировать: мне удалось получить частичноерезультат, но по некоторым причинам я получаю мои примеры для дубликата, так что это еще не совсем правильно. 

"skills": {
      "type": "object",
      "properties": {
        "pithon": {
          "type": "array",
           "items": {
                 "properties" : {
                    "id" : {
                    "type" : "number",
                     "description" : "name of the object"
            },
                    "pithon" : {
                     "type" : "string",
                     "description" : "name of the object"
            }
           }
          }
        },
        "sql": {
          "type": "array",
           "items": {
                 "properties" : {
                    "id" : {
                    "type" : "number",
                     "description" : "name of the object"
            },
                    "mysql" : {
                     "type" : "string",
                     "description" : "name of the object"
            }
           }
          }
        }
      }
    }
...