RestFul规范

最新推荐文章于 2023-05-26 09:30:23 发布
原创 最新推荐文章于 2023-05-26 09:30:23 发布 · 342 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#it

RESTful风格用来包装HTTP协议，并用json或xml格式实现数据交互。
URL命名原则
1、 URL请求采用小写字母，数字，部分特殊符号（非制表符）组成。
2、 URL请求中不采用大小写混合的驼峰命名方式，尽量采用全小写单词，如果需要连接多个单词，则采用连接符“_”连接单词。
GET – 返回一个新的order POST- 创建一个新的order，从post请求携带的内容获取值。
单资源带id(singular-resourceX/{id} ) URL样例：order/1 ( order即指那个单独的资源X )
GET – 返回id是1的order DELETE – 删除id是1的order PUT – 更新id是1的order，order的值从请求的内容体中获取。
GET （SELECT）：从服务器检索特定资源，或资源列表。
POST （CREATE）：在服务器上创建一个新的资源。
PUT （UPDATE）：更新服务器上的资源，提供整个资源。
PATCH （UPDATE）：更新服务器上的资源，仅提供更改的属性。
DELETE （DELETE）：从服务器删除资源。

Restful API优雅原则统一规范
张彦峰的博客
10-14 10万+
本部分预留作业，后续总结后分享。
DRF——RESTful规范
m0_66925868的博客
08-20 932
如果是基于HTTP协议，则意味着用户浏览器再向服务器发送数据时，都是以明文的形式传输，如果你在某咖啡厅上网，他就可以把你网络传输的数据明文都获取到。如果是基于HTTPS协议，则意味着用户浏览器再向服务器发送数据时，都是以密文的形式传输，中途即使有非法用户获取到网络数据，也可以密文的，无法破译。暂且不说restful规范有多好，对于前端和后端只要能统一了规范，对大家的开发效率都会有很大的帮助，不用再做很多无效的沟通了。注意：此处大家先了解https和http的不同，至于底层原理和部署，在项目部署时再细讲。
RESTful 规范
梦否
08-29 4475
1. 基本概念     REST全称是Representational State Transfer，中文意思是表征性状态转移。指的是一组架构约束条件和原则。如果一个架构符合REST的约束条件和原则，我们就称它为RESTful架构。如果后台开发遵守了REST风格便可称为RESTful。 REST本身并没有创造新的技术，是一种软件架构风格，以更好地使用现有Web标准中的一些准则和约束。结构清晰、符合标准、易于理解、扩展方便。     RESTful架构是对MVC架构改进后所形成的一种架构，通过使用事先定义好的
Restful规范
灰海
11-30 7306
1、关于Restful 随着前后端分离越来越普遍，后端接口规范也就越来越重要了。一套良好的接口规范可以提升工作效率，减少沟通障碍。通常我们都会采用RestfulApi方式来提供接口，使用JSON来传输数据。 Restful是一种软件架构风格，不是标准。既然不是标准，可以遵守，也可以不遵守！！！ 2、Api设计6要素 资源路径(URI) HTTP动词(Method) 过滤信息(query-string) 状态码(Status-code) 错误信息(Error) 返回结果(Result)
RESTful规范
weixin_30914981的博客
07-04 118
RESTful 规范 　　一种软件的架构风格，设计风格，而不是标准，为客户端和服务端的交互提供一组设计原则和约束条件。 一 面向资源编程 　　每个URL代表一种资源，URL中尽量不要用动词，要用名词，往往名词跟数据库表格相对应。 二 根据method不同，进行不同的操作 　　GET/POST/PUT/DELETE/PATCH 三 在URL中体现...
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都不知道我怎么敢要你？
热门推荐
dotNet全栈开发
11-06 17万+
干货，2019 RESTful最贱实践
简述RESTful API 设计规范
u014089832的博客
04-15 531
RESTful API 设计规范主要从3个方面来说明：URL设计、状态码以及服务器回应。 一 、URL设计 1.动词+宾语 RESTful的核心思想就是，客户端发出的数据+操作指令都是“动词+宾语”的结构，比如GET /articles这个命令，GET是动词，/articles是宾语，动词通常就有5种HTTP请求方法，对应CRUD操作，根据 HTTP 规范，动词一律大写。 # GET：读...
Restful标准
sky
11-11 511
Restful标准： 一： 前端映射写法： 映射名+ “/” + 参数 即 categories/id=3 后端接收参数写法： @GetMapping("/categories/{id}") public Category get(@PathVariable("id") int id){ return categoryService.get(id); } 二： CRUD 分别对应： 增加： ...
RESTful接口设计规范
浮游的博客
05-26 6173
RESTful是目前最流行的API设计规范，它是用于Web数据接口的设计。从字面可以看出，他是Rest式的接口，所以我们先了解下什么是Rest。REST与技术无关，它代表的是一种软件架构风格，REST它是 Representational State Transfer的简称，中文的含义是: “表征状态转移” 或 “表现层状态转化”。它是基于HTTP、URI、XML、JSON等标准和协议，支持轻量级、跨平台、跨语言的架构设计。
设计一个RESTful 规则
「有且仅有」
03-23 556
一、什么是RESTful历史Roy Thomas Fielding （菲尔丁） 是HTTP 协议的主要作者之一。它在2000年于加州大学艾尔文分校所做的博士毕业论文Architectural Styles and the Design of Network-based Software Architectures 中，描述了一种称为REST 的网络软件架构风格，目的是方便不同软件在网络中互相传递消息
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、付费专栏及课程。

余额充值