REST API:
REST 是 Representational State Transfer
的缩写。这个词组的翻译过来就是“表现层状态转化”。表示“资源”在网络传输中以某种“表现形式”进行“状态转移” 。
- 每一个 URI 代表一种资源;
- 客户端和服务器之间,传递这种资源的某种表现形式比如
json
,xml
,image
,txt
等等; - 客户端通过特定的 HTTP 动词,对服务器端资源进行操作,实现"表现层状态转化"。
REST规范:
GET
:请求从服务器获取特定资源。POST
:在服务器上创建一个新的资源。PUT
:更新服务器上的资源(客户端提供更新后的整个资源)。DELETE
:从服务器删除特定的资源。PATCH
:更新服务器上的资源
REST接口规范:
1.API接口尽量复数名词
2.建议用-
3.建议用版本化API
GET /classes:列出所有班级
POST /classes:新建一个班级 GET /classes/{classId}:获取某个指定班级的信息
PUT /classes/{classId}:更新某个指定班级的信息(一般倾向整体更新)
PATCH /classes/{classId}:更新某个指定班级的信息(一般倾向部分更新)
DELETE /classes/{classId}:删除某个班级
状态码:
2xx:成功 | 3xx:重定向 | 4xx:客户端错误 | 5xx:服务器错误 |
---|---|---|---|
200 成功 | 301 永久重定向 | 400 错误请求 | 500 服务器错误 |
201 创建 | 304 资源未修改 | 401 未授权 | 502 网关错误 |
403 禁止访问 | 504 网关超时 | ||
404 未找到 | |||
405 请求方法不对 |
20240722 来源:JavaGuide