Как отформатировать POST-запрос на apiary.io?

Question

Спасибо за ваше время у меня есть запрос POST, который я хочу документировать на пасеке проекта, заголовок выглядит примерно так:

текст / html

_method: POST

Данные [Пользователь] [имя пользователя]:

Данные [Пользователь] [пароль]:

Данные [Пользователь] [запомнить]: 0

http://d.pr/i/uRFx

У меня есть что-то вроде этого, но я не уверен, как это закончить:

## login [/users/login/{username}{password}{remember}{ident}]
Login with a user and password

+ Parameters

    + username (required, string, `myname`) ... the username format should follow CakePHP: data[User][username].
    + password (required, string, `whatever`) ... the password format should follow CakePHP: data[User][password]
    + remember (required, number, `0`) ... the remember format should follow CakePHP: data[User][remember]
    + ident (optional, number, `0`) ... the ident format should follow CakePHP: data[User][ident]

### make login [POST]

+ login by user (text/plain)
What goes in here???????????

любая идея? Спасибо!

Answer 1

Видимо, это отправка данных в веб-форме. В этом случае Content-Type из application/x-www-form-urlencoded тип.

Тело сообщения запроса имеет специальное форматирование, а некоторые из его символов (квадратные скобки) должны быть%-экранированы. Подробнее о форматировании тела запроса см. Вышеупомянутую статью Wiki.

API Blueprint в его простейшей форме может выглядеть примерно так:

# Login [/users/login]
## Make Login [POST]
+ Request (application/x-www-form-urlencoded)

        data%5BUser%5D%5Busername%5D=qq&data%5BUser%5D%5Bpassword%5Dqq&data%5BUser%5D%5Bremember%5D=0

+ Response 201

Вы сможете увидеть свой пример тела сообщения запроса в инспекторе трафика по ссылке "просмотреть закодированный URL".

Обратитесь к этому плану, чтобы увидеть этот пример в действии.

Также обратитесь к этому такому вопросу для получения дополнительной информации о application/x-www-form-urlencoded,