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

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

nanshan 2024-10-21 06:04 26 浏览 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 设计规范!整个人都清爽了

相关推荐

0722-6.2.0-如何在RedHat7.2使用rpm安装CDH(无CM): 文档编写目的在前面的文档中，介绍了在有CM和无CM两种情况下使用rpm方式安装CDH5.10.0，本文档将介绍如何在无CM的情况下使用rpm方式安装CDH6.2.0，与之前安装C5进行对比。环境介绍：...

ARM64 平台基于 openEuler + iSula 环境部署 Kubernetes: 为什么要在arm64平台上部署Kubernetes，而且还是鲲鹏920的架构。说来话长。。。此处省略5000字。介绍下系统信息；o架构：鲲鹏920(Kunpeng920)oOS：ope...

生产环境starrocks 3.1存算一体集群部署: 集群规划FE：节点主要负责元数据管理、客户端连接管理、查询计划和查询调度。>3节点。BE:节点负责数据存储和SQL执行。>3节点。CN:无存储功能能的BE。环境准备CPU检查JDK...

在CentOS上添加swap虚拟内存并设置优先级: 现如今很多云服务器都会自己配置好虚拟内存，当然也有很多没有配置虚拟内存的，虚拟内存可以让我们的低配服务器使用更多的内存，可以减少很多硬件成本，比如我们运行很多服务的时候，内存常常会满，当配置了虚拟内存...

国产深度(deepin)操作系统优化指南: 1.升级内核随着deepin版本的更新，会自动升级系统内核，但是我们依旧可以通过命令行手动升级内核，以获取更好的性能和更多的硬件支持。具体操作：-添加PPAs使用以下命令添加PPAs：```...

postgresql-15.4 多节点主从(读写分离): 1、下载软件[root@TX-CN-PostgreSQL01-252software]#wgethttps://ftp.postgresql.org/pub/source/v15.4/postg...

Docker 容器 Java 服务内存与 GC 优化实施方案: 一、设置Docker容器内存限制（生产环境建议）1.查看宿主机可用内存bashfree-h#示例输出（假设宿主机剩余16GB可用内存）#Mem:64G...

虚拟内存设置、解决linux内存不够问题: 虚拟内存设置（解决linux内存不够情况）背景介绍　　Memory指机器物理内存，读写速度低于CPU一个量级，但是高于磁盘不止一个量级。所以，程序和数据如果在内存的话，会有非常快的读写速度。但是，内存...

Elasticsearch性能调优(5):服务器配置选择: 在选择elasticsearch服务器时，要尽可能地选择与当前业务量相匹配的服务器。如果服务器配置太低，则意味着需要更多的节点来满足需求，一个集群的节点太多时会增加集群管理的成本。如果服务器配置太高，...

Es如何落地: 一、配置准备节点类型CPU内存硬盘网络机器数操作系统data节点16C64G2000G本地SSD所有es同一可用区3(ecs)Centos7master节点2C8G200G云SSD所有es同一可用区...

针对Linux内存管理知识学习总结: 现在的服务器大部分都是运行在Linux上面的，所以，作为一个程序员有必要简单地了解一下系统是如何运行的。对于内存部分需要知道：地址映射内存管理的方式缺页异常先来看一些基本的知识，在进程看来，内存分为内...

MySQL进阶之性能优化: 概述MySQL的性能优化，包括了服务器硬件优化、操作系统的优化、MySQL数据库配置优化、数据库表设计的优化、SQL语句优化等5个方面的优化。在进行优化之前，需要先掌握性能分析的思路和方法，找出问题，...

Linux Cgroups(Control Groups)原理: LinuxCgroups（ControlGroups）是内核提供的资源分配、限制和监控机制，通过层级化进程分组实现资源的精细化控制。以下从核心原理、操作示例和版本演进三方面详细分析：一、核心原理与...

linux 常用性能优化参数及理解: 1.优化内核相关参数配置文件/etc/sysctl.conf配置方法直接将参数添加进文件每条一行.sysctl-a可以查看默认配置sysctl-p执行并检测是否有错误例如设置错了参数:[roo...

如何在 Linux 中使用 Sysctl 命令?: sysctl是一个用于配置和查询Linux内核参数的命令行工具。它通过与/proc/sys虚拟文件系统交互，允许用户在运行时动态修改内核参数。这些参数控制着系统的各种行为，包括网络设置、文件...

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

一周热门

最近发表

首页
收录
顶部