Невозможно включить схему json в документ swagger - PullRequest
Новая
       28

Невозможно включить схему json в документ swagger

0 голосов
/ 28 февраля 2020

Раньше я использовал RAML для определения определений API, и моя работа состоит в том, чтобы исследовать переход на использование Swagger v3, поскольку теперь он поддерживает синтаксис стиля YAML.

Я хочу перенести очень маленький документ RAML со схемами json и примеры к чванству 3, и я изо всех сил пытаюсь получить схему json в чванство

Я использую документацию на https://swagger.io/docs/ и смотрю на различные другие сообщения в блоге

Это схема json, которую я использую и пытаюсь проникнуть в чванство 

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "analytics": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "format": "date"
            },
            "submission": {
              "type": "string"
            },
            "source": {
              "type": "string"
            },
            "model": {
              "type": "string"
            },
            "count": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "date",
            "submission",
            "source",
            "model",
            "count"
          ]
        }
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "analytics"
  ]
}

Теперь, глядя на документы и другие сообщения о чванстве, я должен определить схемы, используя в качестве тега компоненты затем могут быть ссылками как $ ref: '# / components / schemas / validresponse'

Это то, что я создал, используя документацию swagger 

components:
  schemas:
    validresponse:
      additionalProperties: true
      analytics:
        type: object
        properties: 
          analytics:
            type: array
            items:
              type: object
              properties :
                date:
                  type: string
                  format: date
                submission:
                  type: string
                source:
                  type: string
                model:
                  type: string
                count:
                  type: integer
                required: 
                  - date
                  - submission
                  - source
                  - model
                  - count

Я использую app.swaggerhub.com редактор, и я получаю сообщение об ошибке

"НЕ ДОЛЖНО иметь дополнительные свойства AdditionalProperty: analytics", выделенное в строке правильного ответа

Если я удалите строку AdditionalProperties, тогда я все еще получаю ошибку

У меня нет никакого другого упоминания о AdditionalProperty в моем чванстве do c

Я понятия не имею, почему это не работает. Я надеюсь, что это что-то простое, я сделал неправильно

1 Ответ

0 голосов
/ 28 февраля 2020

Изменить 

components:
  schemas:
    validresponse:
      additionalProperties: true
      analytics:
        type: object
        properties: 
          analytics:
            type: array
            ...

на 

components:
  schemas:
    validresponse:
      additionalProperties: true
                     # <--- no "analytics:" node here.
      type: object   # <--- "type: object" must be indented same as additionalProperties above
      properties: 
        analytics:
          type: array
          ...
...