RESTFUL规范

最新推荐文章于 2025-05-06 18:51:03 发布
原创 最新推荐文章于 2025-05-06 18:51:03 发布 · 237 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

RESTFUL规范，一种软件的架构风格，设计风格，而不是标准，为客户端和服务端的交互提供一组设计原则和约束条件。

规范建议

1.面向资源编程：

每个URL代表一种资源，URL中尽量不要用动词，要用名词，往往跟数据库的表明相对应。

一般来说，数据库中的表都是同种记录的集合，所有API中的名词也用该使用复数。

举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。

https://api.example.com/v1/zoos

https://api.example.com/v1/animals

https://api.example.com/v1/employees

2.HTTP动词：

对于资源的具体操作类型，由HTTP动词表示

GET（SELECT）：从服务器取出资源（一项或多项）。

POST（CREATE）：在服务器新建一个资源。

PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。

PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。

DELETE（DELETE）：从服务器删除资源。

3.在URL中体现版本：

https://www.bootcss.com/v1/

https://v1.bootcss.com/

4.在URL中体现是否是API：

https://www.bootcss.com/api/mycss

https://api.bootcss.com/mycss

5.在URL中的过滤条件：

如果记录的数量很多，服务器不可能都将他们返回给用户。API应该提供参数，过滤返回结果。

?limit=10：指定返回记录的数量

?offset=10：指定返回记录的开始位置。

?page=2&per_page=100：指定第几页，以及每页的记录数。

?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。

?animal_type_id=1：指定筛选条件

6.尽量使用HTTPS：

https://www.bootcss.com/v1/mycss

7.响应时设置状态码：

1** 信息，服务器收到请求，需要请求者继续执行操作

2** 成功，操作被成功接收并处理

3** 重定向，需要进一步的操作以完成请求

4** 客户端错误，请求包含语法错误或无法完成请求

5** 服务器错误，服务器在处理请求的过程中发生了错误

8.返回值：

GET请求 返回查到所有或单条数据

POST请求 返回新增的数据

PUT请求 返回更新数据

PATCH请求 局部更新 返回更新整条数据

DELETE请求 返回值为空

9.返回错误信息：

如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。

error: "Invalid API key"

10.Hypermedia API

如果遇到需要跳转的情况，携带跳转接口的URL

Hypermedia API的设计，比如github的API就是这种设计，访问api.github.com会得到一个所有可用的API的网址列表。

"current_user_url": "https://api.github.com/user",

"authorizations_url": "https://api.github.com/authorizations",

从上面可以看到，如果想获取当前用户的信息，应该去访问 api.github.com/user，就会得到下面的记录

message: "Requires authentication",

documentation_url: "https://developer.github.com/v3/users/#get-the-authenticated-user"

11.其他：

API的身份认证应该使用OAuth 2.0

服务器返回的数据格式，应该尽量是JSON格式，避免使用XML

Restful API优雅原则统一规范
曾经“等你生日那天”都遥远得像未来，如今却可欢愉的挥手说“下个十年见”
10-14 10万+
本部分预留作业，后续总结后分享。
DRF——RESTful规范
m0_66925868的博客
08-20 1017
如果是基于HTTP协议，则意味着用户浏览器再向服务器发送数据时，都是以明文的形式传输，如果你在某咖啡厅上网，他就可以把你网络传输的数据明文都获取到。如果是基于HTTPS协议，则意味着用户浏览器再向服务器发送数据时，都是以密文的形式传输，中途即使有非法用户获取到网络数据，也可以密文的，无法破译。暂且不说restful规范有多好，对于前端和后端只要能统一了规范，对大家的开发效率都会有很大的帮助，不用再做很多无效的沟通了。注意：此处大家先了解https和http的不同，至于底层原理和部署，在项目部署时再细讲。
RESTful之排序
IT之一小佬的博客
07-19 714
对于列表数据，REST framework提供了OrderingFilter过滤器来帮助我们快速指明数据按照指定字段进行排序。 使用方法： 在类视图中设置filter_backends，使用rest_framework.filters.OrderingFilter过滤器，REST framework会在请求的查询字符串参数中检查是否包含了ordering参数，如果包含了ordering参数，则按照ordering参数指明的排序字段对数据集进行排序。 前端可以传递的ordering参数的可选字段值需要在
65、Restful规范
zpp15603669517的博客
07-21 347
文章目录一、Restful的10条规范1、数据的安全保证2、接口特征表现，一看就知道是api接口3、多数据版本共存4、数据即是资源， 均使用名词5、资源操作由请求方式决定(method)6、过滤， 通过在url上传参的形式传递搜索条件7、响应状态码8、错误处理，应返回错误信息， error当作key9、返回结果， 针对不同操作， 服务器向用户返回的结果应该符合一下规范10、也可以返回链接 一、Restful的10条规范 1、数据的安全保证 数据的安全保证：url链接一般采用的是https协议进行传输的，
resultful规范使用
huang_yong_peng的博客
09-09 1万+
resultful规范(建议) 什么是resultful： REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移” REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态 所有的数据，不过是通过...
SpringBoot-22-RESTful统一规范响应数据格式
zhoubangbang1的博客
03-08 567
SpringBoot-22-RESTful统一规范响应数据格式什么是REST? REST是Representational State Transfer的缩写，是在2000年被Roy Thomas Fielding提出的，Fielding是一个很厉害的人物，他是HTTP协议的主要设计者。REST是他对互联网软件构架的原则。REST是一种针对网络应用设计和软件开发方式，降低了开发的复杂性，提高了系统的可伸缩性。如果想要具体了解一下其含义可以查看一下阮一峰老师对REST理解RESTful架构。我们在开发过程中需
restful 规范-10大
lmz_lmz的博客
04-11 389
restful 10大规范 一、协议 API与用户的通信协议，总是使用HTTPs协议。 二、域名 应该尽量将API部署在专用域名之下。 https://api.example.com 如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。 https://example.org/api/ 三、版本（Versioning） 应该将API的版本号放入...
restful 规范
11-21
RESTful API规范是指在设计和开发RESTful API时需要遵循的一些规范和设计原则，以确保API的可读性、可维护性、可扩展性和可靠性。以下是一些常见的RESTful API规范和设计原则： 1.使用HTTP动词来表示对资源的操作，...
Java版多用户B2B2C商城源码，企业级Spring Boot框架，RESTful规范，前后端分离架构，含PC+H5+小程序+APP源码，SpringCloud微服务系统,Java版多用户B2B2C
02-24
Java版多用户B2B2C商城源码，企业级Spring Boot框架，RESTful规范，前后端分离架构，含PC+H5+小程序+APP源码，SpringCloud微服务系统,Java版多用户B2B2C商城源码合集：PC端+H5+小程序+APP，企业级Spring Boot框架，...
RESTful规范
weixin_44626952的博客
12-30 306
目录 RESTful规范(建议) RESTful规范(建议) 一、最原始的接口开发 这种方式虽然可以实现接口的开发，但是一个表的处理就需要4个url，当表单多的时候，需要写大量的url，这样不利于开发，并不是接口开发的最好方法 #url路由分配 urlpatterns = [ path('get_order/', views.get_order), ...
深度理解Restful开发规范【总结】
潜意识Java的博客
03-20 1517
咱们先来看看在 Java 项目里，怎么定义符合 Restful 规范的资源类。假设咱们开发一个简单的博客系统，有文章资源。// 构造函数、getter 和 setter 方法省略这就是咱们的文章资源实体类，里面包含了文章的基本属性，像 ID、标题、内容、创建时间等。@GET// 这里实现从数据库或其他数据源获取所有文章的逻辑@GET// 实现根据 ID 获取特定文章的逻辑@POST// 实现创建新文章的逻辑，比如保存到数据库@PUT。
Restful规范
灰海
11-30 7395
1、关于Restful 随着前后端分离越来越普遍，后端接口规范也就越来越重要了。一套良好的接口规范可以提升工作效率，减少沟通障碍。通常我们都会采用RestfulApi方式来提供接口，使用JSON来传输数据。 Restful是一种软件架构风格，不是标准。既然不是标准，可以遵守，也可以不遵守！！！ 2、Api设计6要素 资源路径(URI) HTTP动词(Method) 过滤信息(query-string) 状态码(Status-code) 错误信息(Error) 返回结果(Result)
HTTP规范 RESTful API设计
2401_88238893的博客
05-06 4475
获取资源：创建资源：更新完整资源：部分更新资源：删除资源。
web中resultful代码json设置规范
qq_28929589的博客
01-07 1050
REST请求规范                 POST POST LIST GET GET LIST PUT DELETE DELETE LIST URL POST /v1/users {   username: "aaaa",   password: "111111",   email: "aa
RESTful API规范（详细版）
贾慧玉的博客
10-15 2238
Restful规范: https://www.colabug.com/228298.html
Restful API返回统一响应体
大海无量的博客
01-24 1万+
1. //统一返回数据格式 public class AppResult<T> { private int code; private String msg; private T data;// 数据 public int getCode() { return code; } public void se...
关于RESTful一些注意事项，和自己整理的接口开发规范
热门推荐
哈库桑的博客
02-21 4万+
最近在研究restful，公司开发要使用，所以自己就去网上找了好些资料，并整理了一套公司开发的接口规范。当然，我也只是刚刚入坑。还不是很全面。但是这就是一个过程。一点点，总会好起来的。以下是就是RESTful接口规范： 一、   URI URI规范 1.不用大写； 2.用中杠 - 不用下杠 _ ； 3.参数列表要encode； 4.URI中的名词表示资源集合，使用复数形式。 5.在R
Restful API设计规范：响应码
程序猿日记
04-22 2750
和别人合作开发过许多项目，也看别人开发过很多项目，发现前后端总会在数据对接的方面产生摩擦。轻则互相推卸责任，重则当众谩骂。 今天把别人整理好的一个关于Restful设计的响应码部分摘录，再结合自己的开发经验，总结写个东西，以备后用。 原文连接：简洁 RESTful API 设计规范！整个人都清爽了！——公众号“程序员晓梦” 操作成功状态码 操作成功状态码以2开头，是2xx的形式。可以根据不...
SpringBoot--RESTful统一规范响应数据格式
Purpletaro的专栏
03-15 452
什么是REST? REST是Representational State Transfer的缩写，是在2000年被Roy Thomas Fielding提出的，Fielding是一个很厉害的人物，他是HTTP协议的主要设计者。REST是他对互联网软件构架的原则。REST是一种针对网络应用设计和软件开发方式，降低了开发的复杂性，提高了系统的可伸缩性。如果想要具体了解一下其含义可以查看一下阮一峰老师对REST理解RESTful架构。 我们在开发过程中需要有一个统一的数据返回格式，这样可以使得所有开发人员返回
restful规范
最新发布
06-13
### RESTful API设计规范与最佳实践 RESTful API 是一种基于资源的架构风格，广泛应用于现代 Web 开发中。以下是关于 RESTful API 的详细设计规范和最佳实践： #### 1. 资源标识 RESTful API 的核心是资源，每个资源都应通过唯一的 URI（Uniform Resource Identifier）进行标识。推荐使用名词而非动词来命名资源，并且以复数形式表示集合资源。例如： - 正确示例：`/users`、`/orders` - 错误示例：`/getUser`、`/placeOrder` 此外，嵌套资源可以通过路径层级表示关联关系。例如，获取用户 `123` 的订单可以使用以下 URL[^1]： ```plaintext /users/123/orders ``` #### 2. HTTP 方法 RESTful API 应严格遵循 HTTP 方法语义，确保操作的语义清晰且一致。常见的 HTTP 方法及其用途如下： - **GET**：用于获取资源，不应产生副作用。 - **POST**：用于创建新资源。 - **PUT**：用于更新或替换整个资源。 - **PATCH**：用于部分更新资源。 - **DELETE**：用于删除资源。 例如，创建一个新用户可以通过以下请求实现： ```http POST /users Content-Type: application/json { "name": "John Doe", "email": "john.doe@example.com" } ``` #### 3. 状态码 HTTP 状态码是客户端理解服务器响应的重要依据。RESTful API 应根据操作结果返回适当的 HTTP 状态码。例如： - 成功创建资源时返回 `201 Created`。 - 成功更新资源时返回 `200 OK` 或 `204 No Content`。 - 资源不存在时返回 `404 Not Found`。 - 客户端请求无效时返回 `400 Bad Request`。 #### 4. 错误处理 清晰的错误处理机制有助于提高 API 的可用性和用户体验。推荐在错误响应中包含详细的错误信息，例如： ```json { "error": { "code": 400, "message": "Invalid request body", "details": "The 'email' field is missing." } } ``` #### 5. 响应格式 RESTful API 通常使用 JSON 格式作为数据交换的标准。响应应结构化且易于解析。例如： ```json { "id": 123, "name": "John Doe", "email": "john.doe@example.com" } ``` #### 6. 分页与过滤 对于大规模数据集，API 应支持分页和过滤功能，以减少不必要的数据传输。例如： ```http GET /users?page=2&size=10&filter=status:active ``` #### 7. HATEOAS HATEOAS（Hypermedia As The Engine Of Application State）是一种增强 API 可发现性的机制。通过在响应中包含链接，客户端可以导航到相关资源。例如： ```json { "id": 123, "name": "John Doe", "email": "john.doe@example.com", "_links": { "self": { "href": "/users/123" }, "orders": { "href": "/users/123/orders" } } } ``` #### 8. 缓存 为了提升性能，RESTful API 应尽可能支持缓存机制。通过设置合适的 HTTP 头部字段（如 `Cache-Control` 和 `ETag`），客户端可以有效利用缓存数据[^4]。 #### 9. 安全性 API 安全性是设计中的关键环节。推荐使用 HTTPS 协议保护数据传输，并结合 OAuth 2.0 等标准实现身份验证和授权。 --- ### 示例代码 以下是一个简单的 Java Spring Boot 实现 RESTful API 的示例： ```java @RestController @RequestMapping("/users") public class UserController { @GetMapping("/{id}") public ResponseEntity<User> getUser(@PathVariable Long id) { User user = userService.findById(id); if (user == null) { return ResponseEntity.notFound().build(); } return ResponseEntity.ok(user); } @PostMapping public ResponseEntity<Void> createUser(@RequestBody User user) { User savedUser = userService.save(user); return ResponseEntity.created(URI.create("/users/" + savedUser.getId())).build(); } } ```
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值