RESTful 接口设计注意事项

分类 Java   关键字 分享   标签 java   web   发布 hongwei  1436257186801
注意 转载须保留原文链接，译文链接，作者译者等信息。  

REST的全称是Representation State Transfer，它描述了一种设计Web应用的架构风格，它是一组架构约束条件和原则，满足这些约束条件和原则的应用程序或设计就是 RESTful风格的。REST原则如下：

• 资源由URI来指定，URI是资源唯一的ID
• 显示的使用HTTP方法，POST=create，GET=read，PUT=update，DELETE=delete
• 资源多重表述，包括JSON、XML、HTML等
• 无状态，不依赖同一台服务器接收请求

接口路径范例

• 模式，http(s)://server.com/app-name/{version}/{domain}/{rest-convention}，
• /order，post，创建order
• /order/{id}，get+put+delete，读取+修改+删除order
• /orders，get或post，列表+分页+搜索
• /order/{id}/items，get或post，订单的子项列表
• /order/{id}/item，post，订单的子项创建
• /order/{oid}/item/{iid}，get+put+delete，订单的子项编辑
  

由于表单仅支持get/post请求，就算手动设定action="put"请求还是会变成get方式，这时需要提交_method参数，服务器端需要配置HiddenHttpMethodFilter。

<form method="post">
<input type="hidden" name="_method" value="put">
<input type="submit">
</form>

web.xml

<filter>
	<filter-name>hiddenHttpMethodFilter</filter-name>
	<filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
	<async-supported>true</async-supported>
</filter>
<filter-mapping>
	<filter-name>hiddenHttpMethodFilter</filter-name>
	<url-pattern>/*</url-pattern>
</filter-mapping>

ajax请求依然需要提交_method参数

appcan.ajax({
   type: 'post',
   url: HHMAS,
   data: {
       _method:'put',
   },
   dataType: 'json',
   success: function(data, status, requestCode, response, xhr) {
       if(requestCode==200){
           alert(JSON.stringify(data))
       }
   }
});

• 
  

 相关阅读

1. singleton or synchronized 单例还是同步？
2. dubbo admin and monitor 服务治理和监控部署
3. Linux ftp 安装配置
4. clear_logs.sh linux日志文件清理脚本
5. JAAS Java认证与授权服务
6. 5个经典的前端面试问题
7. RSAUtil非对称加密解密工具
8. svn配置管理
9. redis缓存配置管理
10. MailUtil 发送邮件工具类

 关键字

1. apidoc 接口文档系统
2. gitolite 代码访问控制
3. logserver 日志服务项目发布
4. 利用“计算器”和公式做房贷计算
5. redis cluster
6. openapi and light-4j
7. jwt token and shiro
8. ps 证件照制作
9. js eval 动态内容生成
10. pdnovel 看书 读书 听书

  支持一下  

  微信关注 xlongwei