Как показать необязательный заголовок в уценке для пасеки?

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

Мой код:

  • Request
    Ключ apiKey может быть передан в заголовке (обратите внимание на верблюжий регистр для «apiKey»)
    Content-Encoding: gzip является необязательным, только если вы сжимаете сущность.

    • Заголовки

      apiKey: `42452-eofefo-4534535` (optional)
Content-Type: application/json
Content-Encoding: gzip (optional)

Вышеупомянутое нормально?


apiary.io
person seinecle    schedule 04.01.2016    source источник

Ответы (1)


arrow_upward
7
arrow_downward

По состоянию на январь 2016 года это невозможно.

С другой стороны, если вы перейдете к дорожной карте API Blueprint, вы найдете Параметры и заголовки MSON, которая в настоящее время находится на стадии RFC; это позволит вам описать заголовки HTTP в синтаксисе MSON и пометить каждый заголовок HTTP как обязательный/необязательный (см. ниже).

+ Response 200 (application/json)
    + Headers
        + Date (Date, optional) - Date at which the message was originated

Надеемся, что скоро появятся заголовки MSON.

person Baggz    schedule 27.01.2016