15、API 标准方法:构建可预测 API 的关键

API 标准方法:构建可预测 API 的关键

1. 标识符概述

在 API 中,标识符是用于唯一指向特定资源的值。优质的标识符应具备以下特性:
- 易于使用
- 唯一性
- 永久性
- 生成快速简便
- 不可预测
- 可读性强
- 可复制
- 可共享
- 信息密度高

从用户角度来看,标识符应为字符串,使用 ASCII 字符集,理想情况下采用 Crockford 的 Base32 序列化格式。此外,标识符应使用校验字符,以区分不存在的资源和永远无法指向资源的标识符(这很可能是错误导致的)。

2. 标准方法的重要性

一个优秀的 API 应具备可预测性。构建可预测 API 的一个有效方法是,在保持一组特定操作(通常称为方法)一致的同时,仅改变可用的资源。这些方法的外观和行为必须在每个细节上保持一致,否则当相同的操作应用于多个资源时表现不一致,可预测性就会完全丧失。

3. 标准方法的动机与背景

设计良好的 API 最有价值的方面之一是,用户能够运用已有的知识,更快地理解 API 的工作原理。在 RESTful API 中,常使用一组标准操作(或方法)来处理 API 定义的各种资源。用户在了解 API 中的资源后,就可以熟悉对这些资源执行的标准方法。

然而,这只有在每个标准方法都真正标准化的情况下才有效,不仅要在整个 API 中保持一致,还要在大多数 Web API 中普遍适用。REST 标准为此类 Web API 标准化奠定了基础,接下来将详细介绍所有标准方法及其应遵循的规则。

4. 标准方
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值