REST API系列—(1)REST API URI(统一资源标识符)设计原则与实践

目录

一、URI 是 REST 的灵魂

二、URI 设计的基本原则

三、URI 设计的层次结构

1. 顶层:资源集合

2. 二级:单个资源

3. 子资源(资源间的从属关系)

4. 复合资源(跨资源聚合)

5. 特殊操作(通过“动作资源”表达)

四、URI + HTTP 方法组合矩阵

五、URI 参数设计规范

路径参数(Path Parameters)

查询参数(Query Parameters)

示例组合

六、良好 URI 设计范例(智能锁系统)

七、常见反例与改进

八、版本控制与命名空间

URI 版本控制方式

命名空间

九、最佳实践总结表

十、REST URI 设计流程图

结论总结


一、URI 是 REST 的灵魂

在 REST 架构中:

URI = 资源(Resource)的唯一标识。

每一个 URI 都代表系统中的一个 资源(对象、集合或状态)。 客户端通过 HTTP 方法(GET/POST/PUT/DELETE)对资源执行操作。

例如:

GET /users/123

表示获取 id=123 的用户资源


二、URI 设计的基本原则

原则 含义 示例
资源导向(Resource-Oriented) URI 表示“名词”,而不是“动作” ✅ /users/123
❌ /getUser
层次清晰(Hierarchical) 使用层级结构反映资源关系 /users/123
/orders/456
避免动词(Use Nouns, not Verbs) 动作由 HTTP 方法表达 ✅ GET /devices
❌ /listDevices
使用复数名词 保持语义一致 /users
/devices
/orders
小写字母 + 短横线分隔 可读性高、兼容性好 /user-roles
/device-logs
路径即资源,操作用方法表达 GET 查询、POST 创建、PUT 更新、DELETE 删除

三、URI 设计的层次结构

1. 顶层:资源集合

/users
/devices
/orders

2. 二级:单个资源

/users/{userId}
/devices/{deviceId}

3. 子资源(资源间的从属关系)

/users/{userId}/orders
/users/{userId}/orders/{orderId}

4. 复合资源(跨资源聚合)

/reports/sales
/analytics/devices/status

5. 特殊操作(通过“动作资源”表达)

REST 推荐不要直接用动词,但可以设计为“子资源动作”:

POST /devices/{id}/lock
POST /devices/{id}/unlock

不推荐:

POST /lockDevice?id=123   ← ❌ 这属于 RPC 风格,不是 REST。

内容概要:本研究聚焦于“绿电直连型电氢氨园区”的优化运行,提出一种直接利用绿色电力驱动制氢合成氨的综合能源系统架构。通过构建包含风/光发电、电解水制氢、氢气储存、合成氨反应及电能直供等关键环节的系统模型,研究旨在实现能源的高效转化梯级利用,降低对外部电网依赖,提升园区能源自洽率经济性。研究综合运用MatlabPython工具进行建模仿真,结合实际气象负荷数据,对系统在不同工况下的运行策略、能量流动、设备容量配置及经济技术指标进行深入分析优化,并形成完整的Word论文文档,为新型零碳产业园区的规划建设提供了理论依据和技术支撑。; 适合人群:具备新能源、电力系统、化工或综合能源系统背景的科研人员,以及从事园区规划、能源管理、低碳技术开发的工程技术人员。; 使用场景及目标:①研究绿电如何高效耦合至化工生产流程,实现“电-氢-氨”多能互补;②掌握综合能源系统(IES)的建模、仿真优化方法,特别是多时间尺度下的运行调度策略;③为撰写高水平学术论文或完成相关课题研究积累数据、代码写作模板。; 阅读建议:此资源包含代码、数据和完整论文,建议使用者先通读Word论文以理解整体框架理论基础,再结合Matlab/Python代码进行复现调试,最后可基于提供的数据和模型进行二次开发,以深化对绿电综合利用技术的理解。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

34号树洞

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值