14RESTful

最新推荐文章于 2022-07-29 01:26:47 发布
最新推荐文章于 2022-07-29 01:26:47 发布
阅读量83 收藏
点赞数
分类专栏： java运营学习笔记 文章标签： restful java 设计模式
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43131525/article/details/118103471
版权
本文详细介绍了RESTful架构的概念，包括资源与URL的设计技巧，以及GET、POST、PUT和DELETE等HTTP方法的使用规范和相应状态码。内容涵盖了资源层次结构、可读性、统一接口原则以及各种操作的幂等性和安全性。此外，还提到了错误处理的常见响应码，为实现高效、一致的API设计提供了指导。
摘要由CSDN通过智能技术生成

1. RESTful概念

REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征）性状态转移。

REST指的是一组架构约束条件和原则。" 如果一个架构符合REST的约束条件和原则，我们就称它为RESTful架构。

1.1资源与URL

URI设计技巧

  • 使用_或-来让URI可读性更好

  • 使用/来表示资源的层级关系

  • 使用?用来过滤资源

  • ,或;可以用来表示同级资源的关系

1.2 统一资源接口

RESTful架构应该遵循统一接口原则，统一接口包含了一组受限的预定义的操作，不论什么样的资源，都是通过使用相同的接口进行资源的访问。接口应该使用标准的HTTP方法如GET，PUT和POST，并遵循这些方法的语义。

1.2.1 GET

  • 安全且幂等

  • 获取表示

  • 变更时获取表示（缓存）

  • 200（OK） - 表示已在响应中发出

  • 204（无内容） - 资源有空表示

  • 301（Moved Permanently） - 资源的URI已被更新

  • 303（See Other） - 其他（如，负载均衡）

  • 304（not modified）- 资源未更改（缓存）

  • 400 （bad request）- 指代坏请求（如，参数错误）

  • 404 （not found）- 资源不存在

  • 406 （not acceptable）- 服务端不支持所需表示

  • 500 （internal server error）- 通用错误响应

  • 503 （Service Unavailable）- 服务端当前无法处理请求

1.2.2 POST

  • 不安全且不幂等

  • 使用服务端管理的（自动产生）的实例号创建资源

  • 创建子资源

  • 部分更新资源

  • 如果没有被修改，则不过更新资源（乐观锁）

  • 200（OK）- 如果现有资源已被更改

  • 201（created）- 如果新资源被创建

  • 202（accepted）- 已接受处理请求但尚未完成（异步处理）

  • 301（Moved Permanently）- 资源的URI被更新

  • 303（See Other）- 其他（如，负载均衡）

  • 400（bad request）- 指代坏请求

  • 404 （not found）- 资源不存在

  • 406 （not acceptable）- 服务端不支持所需表示

  • 409 （conflict）- 通用冲突

  • 412 （Precondition Failed）- 前置条件失败（如执行条件更新时的冲突）

  • 415 （unsupported media type）- 接受到的表示不受支持

  • 500 （internal server error）- 通用错误响应

  • 503 （Service Unavailable）- 服务当前无法处理请求

1.2.3 PUT

  • 不安全但幂等

  • 用客户端管理的实例号创建一个资源

  • 通过替换的方式更新资源

  • 如果未被修改，则更新资源（乐观锁）

  • 200 （OK）- 如果已存在资源被更改

  • 201 （created）- 如果新资源被创建

  • 301（Moved Permanently）- 资源的URI已更改

  • 303 （See Other）- 其他（如，负载均衡）

  • 400 （bad request）- 指代坏请求

  • 404 （not found）- 资源不存在

  • 406 （not acceptable）- 服务端不支持所需表示

  • 409 （conflict）- 通用冲突

  • 412 （Precondition Failed）- 前置条件失败（如执行条件更新时的冲突）

  • 415 （unsupported media type）- 接受到的表示不受支持

  • 500 （internal server error）- 通用错误响应

  • 503 （Service Unavailable）- 服务当前无法处理请求

1.2.4 DELETE

  • 不安全但幂等

  • 删除资源

  • 200 （OK）- 资源已被删除

  • 301 （Moved Permanently）- 资源的URI已更改

  • 303 （See Other）- 其他，如负载均衡

  • 400 （bad request）- 指代坏请求

  • 404 （not found）- 资源不存在

  • 409 （conflict）- 通用冲突

  • 500 （internal server error）- 通用错误响应

  • 503 （Service Unavailable）- 服务端当前无法处理请求

Sheldor369
关注
专栏目录
Restful API 设计
Mongoose House
06-07 848
REST（Representational State Transfer） 是 Roy Fielding 博士在2000年他的博士论文「Architectural Styles and the Design of Network-based Software Architectures(PDF)」中提出来的一种软件架构风格。REST 服务与早前 Web Service 的 SOAP 和 XML-RPC 协议对比来讲更加简洁，现在越来越多的 Web 服务开始采用 REST 风格设计和实现。 Restful
java调用restful接口_Java调用RESTful接口的几种方式
weixin_33940031的博客
02-12 2038
前端一般通过Ajax来调用，后端调用的方式还是挺多的，比如HttpURLConnection，HttpClient，Spring的RestTemplate服务端代码如下：服务端接口请求的URL：http://localhost:8080/rest/user/getUser/xiaoming/18，设定请求方式为GETpackage com.demo.restful.service.impl;imp...
RESTful设计规范
11-02
RESTful设计规范，简单通俗易理解，Github上常用的代码规范
RestFul 风格规范
hero_th的博客
04-12 329
目录 1.GET 方法 2.POST 方法 3.PUT 方法 4.DELETE 方法 restful 统一资源接口 RESTful架构应该遵循统一接口原则，统一接口包含了一组受限的预定义的操作，不论什么样的资源，都是通过使用相同的接口进行资源的访问。接口应该使用标准的HTTP方法如GET，PUT和POST，并遵循这些方法的语义。 如果按照HTTP方法的语义来暴露资源，那么接口将会拥有安全性和幂等性的特性，例如GET和HEAD请求都是安全的， 无论请求多少次，都不会改变服务器状态。而GET、HEAD、PUT和
RESTful 风格 API 设计规范
qq_38358436的博客
11-02 155
1. 配置单独域名 建议将API部署到专用域名下, 如: https://api.example.com 如果不需要考虑扩展可以将API当做一个模块来开发 https://www.example.com/api 2. 将版本放入url中 建议将版本放入url地址中, 如: https://api.example.com/v1.1 3. 使用 http ...
RESTful架构风格规范
qq_43521551的博客
03-03 1291
REST与RESTful介绍 REST翻译为表现层状态转移(Representational State Transfer, REST)，是一种软件架构风格，是Roy Thomas Fielding在他2000年的博士论文中提出的，该结构风格提供一些指导原则和最优方法来帮助我创建可扩展的web服务 REST是应用于分布式系统组件设计的一套协调的约束，它可以带来更高性能和更可维护的体系结构 RESTful风格的API是遵循REST风格构建的API，它可以通过一套统一的接口为Web，IOS和Android提供
RESTful规范风格
旺仔
03-27 429
在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。 举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。 https://api.example.co...
mysql-restful:MySQL RESTful API服务器
05-01
Linux-将计算机设置为接受开放的较低端口，而无需root权限访问NodeJ（80/443），下一个代码适用于Ubuntu 14。 sudo apt-get install libcap2-bin sudo setcap cap_net_bind_service=+ep /usr/local/bin/node 示例...
14springboot+Swagger2构建强大的RESTful API文档1
08-08
在本文中，我们将深入探讨如何使用SpringBoot和Swagger2构建强大的RESTful API文档。RESTful API已经成为现代Web服务的标准设计模式，它强调了资源的概念并通过HTTP操作（如GET、POST、PUT、DELETE）来处理这些资源...
BeastHttp：提供用于使用Boost.Beast创建RESTful服务的辅助工具。
02-03
Boost.Beast是Boost库的一部分，它利用了C++11和C++14的功能，以及Boost.Asio库，来处理HTTP协议。BeastHttp通过提供额外的抽象层和实用工具，简化了开发过程，使得构建高性能Web服务器变得更加容易。 首先，让我们...
RESTFUL风格规范
qq_40677590的博客
11-27 794
目录 1.前言 2.RESTFUL的来源 3.patch和put的区别 4.http的状态码 5.url的命名规范 6.统一的数据返回格式 7.url多参数时的处理 1.前言 现在项目都采用前后端分离开发，所以后端的接口遵循RESTFUL风格很重要。RESTful只是一种架构方式的约束，给出一种约定的标准，完全严格遵守RESTful标准并不是很多，也没有必要。但是在实际运用中，有...
RESTful风格及规范
qesrdtcfvgb的博客
09-28 405
一，RESTful是什么？ REST与技术无关，代表的是一种软件架构风格（REST是Representational State Transfer的简称，中文翻译为“表征状态转移”） 2. REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识 3. 所有的数据，不过是通过网络获取的还是操作（增删改查）的数据，都是资源，将一切数据视为资源是REST区别与其他架构风格的最本质属性 4. 对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构（ROA：
Restful风格API规范详解
qq_43517336的博客
07-14 590
Restful风格API规范Restfun API协议域名版本路径HTTP动词过滤信息(Filtering)状态码(Status Codes)错误处理(Error handling)返回结果 Restfun API REST（Representational State Transfer）全称是表属性状态转移，其实指的就是资源的表述。如果一个架构符合REST原则，就称为Restful架构。 解决问...
RESTful规范
weixin_30914981的博客
07-04 97
RESTful 规范 　　一种软件的架构风格，设计风格，而不是标准，为客户端和服务端的交互提供一组设计原则和约束条件。 一 面向资源编程 　　每个URL代表一种资源，URL中尽量不要用动词，要用名词，往往名词跟数据库表格相对应。 二 根据method不同，进行不同的操作 　　GET/POST/PUT/DELETE/PATCH 三 在URL中体现...
Restful规范
灰海
11-30 7184
1、关于Restful 随着前后端分离越来越普遍，后端接口规范也就越来越重要了。一套良好的接口规范可以提升工作效率，减少沟通障碍。通常我们都会采用RestfulApi方式来提供接口，使用JSON来传输数据。 Restful是一种软件架构风格，不是标准。既然不是标准，可以遵守，也可以不遵守！！！ 2、Api设计6要素 资源路径(URI) HTTP动词(Method) 过滤信息(query-string) 状态码(Status-code) 错误信息(Error) 返回结果(Result)
RESTful 规范
梦否
08-29 4387
1. 基本概念     REST全称是Representational State Transfer，中文意思是表征性状态转移。指的是一组架构约束条件和原则。如果一个架构符合REST的约束条件和原则，我们就称它为RESTful架构。如果后台开发遵守了REST风格便可称为RESTful。 REST本身并没有创造新的技术，是一种软件架构风格，以更好地使用现有Web标准中的一些准则和约束。结构清晰、符合标准、易于理解、扩展方便。     RESTful架构是对MVC架构改进后所形成的一种架构，通过使用事先定义好的
restful风格
热门推荐
刘超军的博客
08-24 13万+
概念 一种软件架构风格、设计风格，而不是标准，只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。 URL定义 资源：互联网所有的事物都可以被抽象为资源 资源操作：使用POST、DELETE、PUT、GET，使用不同方法对资源进行操作。 分别对应 添加、 删除、修改、查询。 ...
RESTful 风格详解
weixin_43189971的博客
07-29 9118
@RequsetParam @PathVariable 使用规范
RESTful服务最佳实践指南
14. **REST快速提示**： - **使用HTTP动词有意义**：每个HTTP方法（GET、POST、PUT、DELETE等）应对应特定的操作。 - **合理的资源命名**：资源名称应清晰、简洁且具有一致性。 - **XML和JSON**：选择合适的格式...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值