设计文档规范 v1

每个帮助文档应该只包含一类业务的API，在标题中应该明确版本号，以防使用中版本错误。

功能1

POST /foo/bar

NOTE

对功能1的简要说明，必要时提供，不强求

TOKEN

明确该API是否需要提供token，可以有三种取值：required, not required, optional * required

INPUT&OUTPUT参数统一规范

(本规范熟记遵守，不要出现在其他文档中) * 所有时间参数，都使用时间戳，杜绝字符串。其命名统一用“time”做后缀，不要出现“date” * 某个字段如果类型是对象或单个值，但由于特殊原因不存在，可以不传，杜绝以null形式返回 * 某个字段数据列表，如果数据一个都没有，请依然返回空数组[],而不是没有值或null * 所有返回数据，必须以code+object并列反馈，切忌出现只返回object没有code的情况 * 返回数据中，并列的几个字段，如果来自于同一个数据结构，应以object形式组织起来，便于以后拓展维护

INPUT

json格式的输入参数，通过http的POST数据传给服务端

{
    "id": "123456",
    "name": "rod"
}

OUTPUT

json格式的输出值

{
    "id": "123456",
    "name": "rod"
}

ERROR

可能的错误返回 * ErrNoPassword * ErrWrongName

CURL

curl -X POST -d {"id":"123456"} http://locahost/foo/bar