restful api 规范

1、参数验证错误统一状态码 status:”412”     ，状态码用字符串保存（int类型无法兼容其他基础设施抛出的异常状态码） 

返回格式：

{

    "status": "0",

    “message": "success",

    "result”:[]

}

对于列表结果需要再包一层，方便日后扩展，比如：

{

    "status": "0",

    “message": "success",

    "result”:[

            {

                “id” : 1,

                “name” : “hello"

            },

            {

                “id”: 2,

                “name” : “world"

            }

    ]

}

如果需要再加个字段统计用户个数就不方便了 ，所以要在包一层：

{

    "status": "0",

    “message": "success",

    "result”:[

            “Users” ：[{

                “id” : 1,

                “name” : “hello"

            },

            {

                “id”: 2,

                “name” : “world"

            }]

    ]

}

2、post 和 put 成功后需要返回完整对象，不能直接返回空

Put 接口应该能支持传哪个参数就修改哪个字段的指， 不传就不更改，  所以项目中还是建议用ORM比较省事

3、url中的资源名必须是名词，且统一用复数，避免某些资源单词会产生歧义：

比如：person/people ,  goose / geese ， fish/fish

标准的范例：

GET /tickets          返回列表

GET /tickets/12   返回id为12的记录

4、如何处理资源的关系：

如果一个资源必须通过另外一个资源才能获取到，那么其url应该如：

GET /tickets/1/messages/12

如果一个资源可以单独存在，那么其url应该如：

GET /messages/12

5、PUT 和 POST的区别：

PUT： 当资源不存在时创建资源，资源已存在时修改资源，幂等

POST：创建新资源，非幂等

6、数组参数形式

Id[]=1&id[]=2

7、每个字段的返回类型要定义好

对于php这种弱类型的语言默认会返回string类型，要做适当转换。