RESTFUL API 常用动作以及状态码

RESTFUL API 动作:

GET /zoos:列出所有动物园
POST /zoos:新建一个动物园
GET /zoos/ID:获取某个指定动物园的信息
PUT /zoos/ID:更新某个指定动物园的信息(提供该动物园的全部信息)
PATCH /zoos/ID:更新某个指定动物园的信息(提供该动物园的部分信息)
DELETE /zoos/ID:删除某个动物园
GET /zoos/ID/animals:列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID:删除某个指定动物园的指定动物

常用状态码:

200 OK  [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。
201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。
202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)
204 NO CONTENT - [DELETE]:用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。
401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。
403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。
404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。
406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。
410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。
### RESTful API 的常见用法 RESTful API 使用 HTTP 方法来操作资源,遵循统一接口的原则。常见的 HTTP 方法有 GET、POST、PUT 和 DELETE。 - **GET 请求**用于从服务器检索信息而不修改其上的数据。此请求通常用于查询数据库记录或获取文件内容[^1]。 - **POST 请求**向指定资源提交数据以创建子节点,例如发布新消息到论坛帖子中;还可以用于触发某些处理逻辑而无需更改URI所指向的实际资源。 - **PUT 请求**更新现有实体实例的数据或将整个表示替换为目标位置处已知存在的资源的新版本。 - **DELETE 请求**删除由 URI 标识的特定资源。 ```http GET /users/12345 // 获取ID为12345的用户详情 POST /users // 创建一个新的用户条目 PUT /users/12345 // 更新ID为12345用户的资料 DELETE /users/12345 // 删除ID为12345对应的用户账户 ``` ### RESTful API 最佳实践 为了使 RESTful API 更加健壮和易于理解,在设计时应该考虑以下几个方面: #### 资源清晰化 采用名词作为 URL 中的一部分,并保持一致性。避免使用动词,因为动作已经通过 HTTP 动词表达出来。对于集合型资源,总是返回数组形式的结果集而不是单个项目[^2]。 #### 正确应用状态码 除了常用的 `2xx` 成功系列外,还应当合理运用其他类别如 `4xx` 客户端错误 或者 `5xx` 服务端故障 来指示不同类型的异常情况给调用方知道发生了什么问题并采取相应措施[^3]。 | 状态码 | 描述 | | --- | --- | | 200 OK | 请求成功 | | 201 Created | 已创建 | | 400 Bad Request | 错误请求 | | 401 Unauthorized | 需要身份验证 | | 403 Forbidden | 拒绝访问 | | 404 Not Found | 找不到 |
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

-七秒钟记忆

微薄打赏,小编的动力

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

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

打赏作者

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

抵扣说明:

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

余额充值