如何在apiary.io上格式化POST请求？

Question

感谢您的时间，我有一个POST请求，我想记录在蓝图蜂巢，标题是这样的：

text/html

_method:POST

dataUser

dataUser

数据用户: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

很明显这是submitting the data in a web form。在本例中，Content-Type的类型为application/x-www-form-urlencoded。

请求的消息体有特殊的格式，而且它的一些字符(方括号)必须进行%转义。有关请求正文格式的详细信息，请参阅aforementioned Wiki article。

API蓝图最简单的形式可能类似于：

# 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

您应该能够在流量检查器中的"view URL encoded“链接下看到请求消息体的示例。

请参考this blueprint查看此示例的实际操作。

有关application/x-www-form-urlencoded的更多详细信息，请参阅this SO question。