当前位置：网站首页 > 技术文章 > 正文

良好的URI设计的一些基本原则（uri设计应遵循原则）

nanshan 2024-10-21 06:04 21 浏览 0 评论

良好的URI设计的一些基本原则

不要使用查询参数来更改状态。
不要使用大小写混用的路劲除非有必要，最好的都是小写字母。
不要使用实现特定的扩展你的URI（php，py，PL，等。）
不要让你的URI有远程过程调用（RPC）的缺陷
尽可能多地限制URI空间。
保持路径段短
最好用/resource或者/resource/；同时为你没有用到的路径创建301重定向
使用查询参数对于一个子资源的选择；如分页、搜索查询
不要在URL中填写任何东西，应该放在HTTP头或正文中去。

（注意：我没有说“RESTful URI设计”；URI本质上是不透明的REST。）

HTTP方法选择的11个基本原则：

永远不要GET去改变状态；这会让Googlebot毁掉你的一天
不要用PUT，除非你要更新整个resource
不要用PUT，除非你可以一直合法的用GET在同一个URI上
不要用POST来检索信息，那是长效的并且可能被缓冲
不要执行一个操作是非幂等的PUT
尽可能使用get
当不确定使用PUT还是POST时，优先使用POST
要使用POST当你需要做一些类似RPC时
对类较大或层次的资源使用PUT
删除资源时，优先选择DELETE而不是POST
在做计算之类的请求时，优先使用GET；除非你的INPUT很大，这是你可以考虑使用POST

Web服务中HTTP设计的一般原则：

不要将元数据放在body中，应该放在header中。
不要将元数据放在单独的资源中，除非当包含元数据时会造成很大的开销。
使用适当的状态码

201 Created指创建资源时；在发送响应时资源必须存在
202 Accepted指成功执行一个操作或异步创建资源
400 Bad Request指当有人用伪造的数据进行操作；应用程序可能是一个验证错误；一般保存为500的未捕获的异常
401 Unauthorized指当某人访问您的API时，未提供必要的授权header或授权中的凭据无效时；如果您不希望通过授权header来进行凭证，则不要使用此响应代码。
403 Forbidden指当某人恶意或未经授权的方式访问你的API时
405 Method Not Allowed指当本来必须用PUT，而有人却POST时，等等
413 Request Entity Too Large指当某人试图发送一个无法接收的大文件时
418 I’m teapot 指当我试图用茶壶冲泡咖啡时

尽可能使用缓存Headers

ETag headers让你很容易的将资源设置为哈希值
Last-Modified向你表明，保留资源更新时的时间戳是一个好主意。
Cathe-Control和Expires应该有一个合理的值。

尽一切可能执行请求中的缓存headers（If-None-Modified, If-Modified-Since）
使用重定向的时一定要有意义，但这应该是罕见的Web服务

405 not allowed

上一篇：HTTP协议——处理状态和返回状态码含义
下一篇：简洁 RESTful API 设计规范!整个人都清爽了

相关推荐

删库之后不要着急跑路，教你神不知鬼不觉找回数据: 在工作中，我们误删数据或者数据库，我们一定需要跑路吗？我看未必，程序员一定要学会自救，神不知鬼不觉的将数据找回。在mysql数据库中，我们知道binlog日志记录了我们对数据库的所有操作，所以...

数据库告警不可用，增删改受阻（数据库限制删除）: 前言：昨晚，突然出现服务不可用告警，查看日志上线报文入库到数据库很慢并受阻，出现数据不同步问题。排查问题查看发现服务都是在执行update、insert这些DML命令的时候，报的数据库执行超时。经过一...

Binlog实现MySQL复制，5个关键步骤，务必掌握!: 复制是MySQL最重要的功能之一，MySQL集群的高可用、负载均衡和读写分离都是基于复制来实现的。Binlog就是实现主从复制的关键，主数据库将修改操作记录到Binlog中，从数据库通过解...

MySQL数据实时增量同步到Elasticsearch: Mysql到Elasticsearch的数据同步，一般用ETL来实现，但性能并不理想，目前大部分的ETL是定时查询Mysql数据库有没有新增数据或者修改数据，如果数据量小影响不大，但如果几百万上千万的...

MySQL 数据库恢复:如何执行时间点恢复(PITR)以挽救受损数据?: 天津鸿萌科贸发展有限公司从事数据安全服务二十余年，致力于为各领域客户提供专业的数据恢复、数据备份、数据取证、数据迁移、网络安全、数据清除等解决方案，并针对企业面临的数据安全风险，提供专业的相关数据安全...

阿里面试:MySQL Binlog有哪些格式?底层原理?优缺点?: binlog的格式也有三种：STATEMENT、ROW、MIXED，下面我详解binlog三种模式@mikechenStatement模式Statement模式：是基于SQL语句的复制(statem...

快速带你读懂MySQL的binlog写入机制: 深入讲解MySQL中的重要日志binlog的写入机制以及影响IO性能的关键配置，并且介绍了如何利用binlog去恢复数据，保证MySQL的可靠性。Q：binlog写入时机binlog的写入逻辑并...

MySQL 误删除数据恢复全攻略:基于 Binlog 的实战指南: 在MySQL的世界里，二进制日志（Binlog）就是我们的"时光机"。它默默记录着数据库的每一个重要变更，就像一位忠实的史官，为我们在数据灾难中提供最后的救命稻草。本文将带您深入掌握如...

一文了解MySQL Binlog（一文了解肝脏有益和有害的食物）: MySQL的Binlog日志是一种二进制格式的日志，Binlog记录所有的DDL和DML语句(除了数据查询语句SELECT、SHOW等)，以Event的形式记录，同时记录语句执行时...

数据丢失?别慌!MySQL备份恢复攻略: 想象一下，某个晴朗的午后，你正享受着咖啡，突然接到紧急电话：你的网站或APP彻底挂了！系统崩溃，界面全白。虽然心头一紧，但你或许还能安慰自己：系统崩溃只是暂停服务，数据还在，修复修复就好了。然而，如果...

Mysql中的bin log、redo log、undo log的区别: 最近在整理面试题，在看mvcc的时候看到了undolog，今天索性把这三个log都记录一遍。MySQL的逻辑架构说之前先说一下MySQL的基本架构，MySQL主要分为两层：Server层和存储引...

binlog日志定时清理（binlog清理规则）: binlog日志binlog是MySQL数据库的一种日志文件，用于记录所有对数据的修改操作。binlog全称为binarylog，它以二进制格式记录MySQL服务器上所有的修改操作，包括对哪个数据库...

茶水间炸锅了!菜鸟误删用户表，运维老张的MySQL救命三招!: （公司茶水间，运维老张、开发小王和新人小李围着咖啡机）小李：（紧张兮兮）张哥！我...我好像把测试库的用户表删了！下午演示咋办啊？老张：（淡定喝咖啡）慌啥？昨晚的备份是吃干饭的？走，教你恢复！一、基础...

解决运维痛点，提高运维安全性-雷池 SafeLine WAF新功能身份认证: 雷池介绍使用雷池SafeLineWAF已经两年多了，在1.5.x版本时就已经开始测试使用，并在推出LTS版本后转入LTS分支。近期雷池SafeLineWAF重点更新了身份认证功能，并提供了SS...

【Docker 新手入门指南】第十五章:常见故障排除: 一、前期准备：收集关键信息在排查问题前，建议先获取以下系统数据，便于精准定位故障：1.系统基础信息#查看Docker版本（确认是否为最新稳定版）dockerversion#查看...

取消回复欢迎你发表评论:

一周热门

最近发表

首页
收录
顶部