restful api如何更好的设计RESTful API

如何更好的设计RESTful API

1.接口命名规则 http://ip:端口/v1/接口名 IP：服务器IP地址 端口：Restful端口号 V1：版本号(1) 接口名： 命名规则：现有接口方法去第一个单词后，全小写命名，如： 城市信息查询， 原接口名：queryCityId (String id) Restful接口：http://ip:端口/v1/cityid 2.参数规则 参数提交方式：Application/www-form-urlencoded 参数命名：单词采取小写，复合词采取下划线分开的全小写命名。 参数规则：批量查询需有page_size以及page_num参数，避免一次性查询，部分参数需有默认值设定。 Restful接口设计原则 l 使用标准HTTP方法实现资源CURD操作； l 采用json作为API输入输出； l 以json输出错误信息。 注：Http协议详解 HTTP请求方法在 RESTfulAPI 中的典型应用 一组资源的URI，比如 http://ip:8080/v1/ user/ 列出 URI，以及该资源组中每个资源的详细信息（后者可选）。 使用给定的一组资源替换当前整组资源。 在本组资源中创建/追加一个新的资源。该操作往往返回新资源的URL。 删除 整组资源。 单个资源的URI，比如 http://ip:8080/v1/user/1 获取 指定的资源的详细信息，格式使用JSON 替换/创建 指定的资源。并将其追加到相应的资源组中。 把指定的资源当做一个资源组，并在其下创建/追加一个新的元素，使其隶属于当前资源。 删除 指定的元素。 PUT 和 DELETE 方法是幂等方法。GET方法是安全方法 （不会对服务器端有修改，因此当然也是幂等的）。 支持的返回码列表： HTTP返回码 实现举例 例如，一个简单的客户管理应用: 列举所有客户： URL: GET http:// ip: 8080/v1/crm/customer 输入：无 输出：略 呈现某一位客户： URL: GET http:// ip: 8080/v1/crm/customer/[customer id] 输入：无 输出：略 新增客户： URL: POST http:// ip: 8080/v1/crm/ customer 输入：略 输出：略 更新用户： 根据更新参数，需要更新哪些参数就选哪些参数。