Api-blueprint: Тип, допускающий значение NULL, не работает в объявлении метода

Созданный на 13 апр. 2016 · 3Комментарии · Источник: apiaryio/api-blueprint

Я пытаюсь использовать тип, допускающий значение NULL, в моем mson, следующем примере в документации, но это не удается из-за семантической ошибки.

Пожалуйста, помогите мне разобраться, что не так с моим mson и как составить правильную документацию для моего варианта использования?

Спасибо!

Apiary.io Question

Источник

danilvalov

👍1

Самый полезный комментарий

Я просто хочу указать, что теперь это было развернуто на Apiary (без бета-версии).

Например, вы можете использовать значение NULL, как показано ниже:

+ 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"
    }
  }
}

В таблице атрибутов в Apiary еще не упоминается, что значение допускает значение NULL , но это скоро.

screen shot 2016-06-20 at 17 46 45

kylef 20 июн. 2016

👍4

Все 3 Комментарий

Привет, @danilvalov ,

У Apiary есть бета-версия для улучшения рендеринга атрибутов, которая включает поддержку допустимости значений NULL. Вы можете узнать больше о бета-версии на https://github.com/apiaryio/api-blueprint/issues/191#issuecomment -178044764, а также о том, как присоединиться к ней.

С уважением,

Кайл

kylef 13 апр. 2016