определение параметров json-сообщения на пасеке

Я пытаюсь создать документацию для проекта, используя почтовые запросы json.
Теперь для запросов на получение я могу легко определить параметры uri.

Однако я хочу сделать то же самое для json и других почтовых запросов.
Я пробовал и хотел, чтобы это работало примерно так, как показано ниже, он отображает параметры в примере, но, похоже, это не способ сделать это. .
Есть ли способ сделать это правильно?

## Post Inbound [/ws/3/inbound]
### Post Inbound [POST]


+ Request

        {
            "authentication":
                {
                    "location":"{location}",
                    "customer_id":{customer_id},
                    "context":"{context}"
                },
            "date":"",
            "reference":"",
            "details":
            [
                {
                    "article_code":"",
                    "qty_expected":
                },
                {
                    "article_code":"",
                    "qty_expected":
                }
            ]
        }

+ Parameters
    + location (required, string) - Target url of the wics server 
    + customer_id (required, int) - Customer ID
    + context (required, string) - Authentication context gotten from login
    + date (required, date) - Date format as yyyy-mm-dd
    + reference (required, string) - Reference
    + article_code (required, string) - Article code
    + qty_expected (required, int) - Quantity expected.

apiary.io apiblueprint apiary
person HTDutchy    schedule 14.07.2015    source источник

Ответы (1)


arrow_upward
5
arrow_downward

Ключевое слово Parameters должно указывать URI параметры в API Blueprint, тогда как Атрибуты предназначено для указания атрибутов, таких как те, которые указаны в тексте запроса или ответа.

Для вашего запроса это будет выглядеть примерно так:

## Post Inbound [/ws/3/inbound]
### Post Inbound [POST]

+ Request (application/json)

    + Attributes
        + authentication (required, object)
            + location (required, string) - Target url of the wics server 
            + customer_id (required, number) - Customer ID
            + context (required, string) - Authentication context gotten from login
        + date: `2015-12-30` (required, string) - Date format as yyyy-mm-dd
        + reference (required, string) - Reference
        + details (required, array)
            + (object)
                + article_code (required, string) - Article code
                + qty_expected (required, number) - Quantity expected.

+ Response 204

И отображается как таковой в Apiary:

MSON расширен и отрендерен на пасеке

Полную спецификацию MSON (синтаксис для обозначения объектов, используемый в API Blueprint) можно найти по адресу https://github.com/apiaryio/mson.

person kylef    schedule 14.07.2015