RestFul API

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

含状态传输（英文：Representational State Transfer，简称REST）



目前三种主流的Web服务实现方案中
 

需要注意的是，REST是设计风格而不是标准。REST通常基于使用HTTP，URI，和XML以及HTML这些现有的广泛流行的协议和标准。

 
  • 资源是由URI来指定。
  • 对资源的操作包括获取、创建、修改和删除资源，这些操作正好对应HTTP协议提供的GET、POST、PUT和DELETE方法。
  • 通过操作资源的表现形式来操作资源。
  • 资源的表现形式则是XML或者HTML，取决于读者是机器还是人，是消费web服务的客户软件还是web浏览器。当然也可以是任何其他的格式
含状态传输的Web服务（Restful Web API）是一个使用Http并遵循Rest原则的Web服务。它从以下三个方面资源进行定义：
 
  • 直观简短的资源地址：URI，比如：http://example.com/resources/。
  • 传输的资源：Web服务接受与返回的互联网媒体类型，比如：JSON，XML ，YAML 等。
  • 对资源的操作：Web服务在该资源上所支持的一系列请求方法（比如：POST，GET，PUT或DELETE）。



下表列出了在实现 含状态传输的 Web 服务时HTTP请求方法的典型用途。

 

   HTTP 请求方法在RESTful Web 服务中的典型应用
   [1]
  
资源GETPUTPOSTDELETE
一组资源的URI，比如http://example.com/resources/列出 URI，以及该资源组中每个资源的详细信息（后者可选）。使用给定的一组资源替换当前整组资源。在本组资源中创建/追加一个新的资源。
 该操作往往返回新资源的URL。删除 整组资源。
单个资源的URI，比如http://example.com/resources/142获取 指定的资源的详细信息，格式可以自选一个合适的网络媒体类型（比如：XML、JSON等）替换/创建指定的资源。并将其追加到相应的资源组中。把指定的资源当做一个资源组，并在其下创建/追加一个新的元素，使其隶属于当前资源。删除 指定的元素。




REST的优点

 
  • 可更高效利用缓存来提高响应速度，通常Post方式是没有缓存机制的，因此不是查询数据的首选。
  • 通讯本身的无状态性可以让不同的服务器的处理一系列请求中的不同请求，提高服务器的扩展性
  • 浏览器即可作为客户端，简化软件需求
  • 相对于其他叠加在HTTP协议之上的机制，REST的软件依赖性更小
  • 不需要额外的资源发现机制
  • 在软件技术演进中的长期的兼容性更好
REST API 设计方面的最佳实践：

 
  1. 如何规划资源标识结构与 URI 模式
  2. 如何根据应用场景提供内容协商
  3. 如何正确的使用 HTTP 响应代码
  4. 如何处理缓存和并发请求
  5. 如何利用数据冗余和链接元素

参考资料：
 

RestAPI最佳实践：https://www.ibm.com/developerworks/cn/web/1103_chenyan_restapi/
 

Http Head Feild：http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
 

Http头中有Cache-control：http://www.cnblogs.com/yuyii/archive/2008/10/16/1312238.html
 

 

缓存控制：
缓存控制通常是需要客户端，缓存服务器 / 代理服务器与业务服务器一起发生作用。
HTTP 头中有“Cache-control”字段来控制如何使用缓存，常见的取值有 private、no-cache、max-age、must-revalidate 等。比如当你给返回的数据内容设置 max-age=600，那么当用户隔了 30 秒再次请求的时候，就不会导致重新请求后台数据。
另外，也可以通过“Expires”字段来指定内容过期时间，在此时间前的请求都不会导致后台程序重新请求数据。
下图展示了 max-age 是如何工作的。

图 2. 缓存控制工作方式的简单范例
图 2. 缓存控制工作方式的简单范例 
 

 

参考资料

 




                

        

    



  



    



                



	

		

			

				
					
Restful API优雅原则统一规范

				
			

			

				

					曾经“等你生日那天”都遥远得像未来，如今却可欢愉的挥手说“下个十年见”
				

				

					10-14
					
					10万+
					
				

			

		

		

			
				
本部分预留作业，后续总结后分享。

			
		

	



                

            
              



	

		

			

				
					
Python Flask高级编程之RESTFul API前后端分离精讲第七章节

				
			

			

				

					03-19
				

			

		

		

			
				
Python Flask高级编程之RESTFul API前后端分离精讲第六章节Python Flask高级编程之RESTFul API前后端分离精讲第六章节Python Flask高级编程之RESTFul API前后端分离精讲第六章节Python Flask高级编程之RESTFul API...

			
		

	



              


  
              

                


	

		

			

				
					
JEESZ RestFul服务介绍

				
			

			

				

					civtsbiqr522632413的博客
				

				

					08-03
					
					148
					
				

			

		

		

			
				
摘要: RESTful Web 服务的关键特点是明确使用 HTTP 方法来表示不同的操作的调用。 REST 的基本设计...


	1. REST介绍


	REpresentational State Tra...

			
		

	





	

		

			

				
					
Restful API 设计原则

				
			

			

				

					Mr.Phoebe的专栏
				

				

					04-10
					
					7570
					
				

			

		

		

			
				
Restful API 设计原则



前言

网络应用程序分为前端和后端两个部分。

当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备……），这也就意味着前端的开发代码、开发框架变得多种多样。因此，必须有一种统一的机制，方便不同的前端代码与后端进行通信。

这就导致了API构架的流行。REST是目前比较成熟的一套互联网应用程序的API设计理论。 它可以降低开发的复杂度，提...

			
		

	



		

			
		



	

		

			

				
					
REST与RESTFul API最佳实践

					
热门推荐

				
			

			

				

					
				

				

					05-30
					
					3万+
					
				

			

		

		

			
				
我经常会面试一些做PHP的开发者，让我很奇怪的是，10个人总有8个多不知道什么是REST服务，甚至是没有听说过。但RESTFul API已经是现在互联网里对外开放接口的主流模式，可参考：

豆瓣API https://developers.douban.com/wiki/?title=api_v2

GitHub https://developer.github.com/v3/

数一

			
		

	





	

		

			

				
					
Restful API

				
			

			

				

					LYB的博客
				

				

					06-25
					
					1012
					
				

			

		

		

			
				
RESTful API是一种遵循REST架构风格的API设计规范，其核心思想是将网络资源抽象化并通过HTTP动词进行操作。主要特点包括：URI代表资源（使用复数名词）、HTTP方法（GET/POST/PUT/DELETE等）对应操作、统一状态码和响应格式。相较于传统面向操作的API设计，RESTful风格将关注点转向资源本身，使用统一的资源路径配合不同HTTP方法实现CRUD操作，使系统更加清晰规范。设计要点还包含版本控制、过滤参数和超媒体API等扩展能力。这种设计风格提高了API的可读性、可维护性和扩展性

			
		

	





	

		

			

				
					
RESTful API

				
			

			

				

					qq_22325611的博客
				

				

					12-10
					
					1915
					
				

			

		

		

			
				
RESTful API 是一种基于 HTTP 协议的轻量级 Web 服务接口，广泛应用于现代 Web 开发中。通过遵循 REST 架构风格，它提供了简洁、可扩展且易于维护的接口设计方式。在使用 RESTful API 时，合理的设计和良好的实践可以帮助构建高效、可维护的系统。

			
		

	





	

		

			

				
					
RESTful API 详解

				
			

			

				

					2301_79858914的博客
				

				

					12-02
					
					1540
					
				

			

		

		

			
				
REST（表述性状态转移）是一种架构风格，并非一个严格的协议。由 Roy Fielding 在其博士论文中提出，REST 强调通过标准的 HTTP 方法对资源进行操作，而不是依赖于复杂的函数或操作。RESTful API 基于 REST 架构风格，实现了 Web 资源的 CRUD（创建、读取、更新、删除）操作。是一种符合 REST 架构风格的 Web 服务接口。它通过 HTTP 协议传输数据，利用 URL 作为资源标识符，并通过标准 HTTP 方法对资源进行操作。

			
		

	





	

		

			

				
					
restful api

				
			

			

				

					fanzhe的博客
				

				

					11-14
					
					328
					
				

			

		

		

			
				
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）GET（SELECT）：从服务器取出资源（一项或多项）POST（CREATE）：在服务器新建一个资源。DELETE（DELETE）：从服务器删除资源。patch方法用来更新局部资源。put方法用来更新全部资源。

			
		

	





	

		

			

				
					
RestFul API 简明教程

				
			

			

				

					2403_87122707的博客
				

				

					01-06
					
					1918
					
				

			

		

		

			
				
上面是 RESTful API 最基本的东西，也是我们平时开发过程中最容易实践到的。因为 REST 中的资源往往和数据库中的表对应，而数据库中的表都是同种记录的"集合"（collection）。现在有这样一个 API 提供班级（class）的信息，还包括班级中的学生和教师的信息，则它的路径应该设计成下面这样。另外，API 的使用也不是没有章法的，它的规则由（比如数据输入和输出的格式）API 提供方制定。但是， API 不仅仅代表后端系统暴露的接口，像框架中提供的方法也属于 API 的范畴。

			
		

	





	

		

			

				
					
RESTful api

				
			

			

				

					qq_40407998的博客
				

				

					10-28
					
					3140
					
				

			

		

		

			
				
官网
https://restfulapi.cn/
REST 是 Representational State Transfer的缩写，如果一个架构符合REST原则，就称它为RESTful架构
使用原因：RESTful 架构可以充分的利用 HTTP 协议的各种功能，是 HTTP 协议的最佳实践
RESTful API 是一种软件架构风格、设计风格，可以让软件更加清晰，更简洁，更有层次，可维护性更好
API 请求
1. HTTP 动词
GET：   读取（Read）
POST：  新建（Create）
PUT

			
		

	





	

		

			

          精选资源
				
					
SpringBoot+Mybatis+CXF框架，实现Restful api与 WebService api接口的大实验

				
			

			

				

					04-07
				

			

		

		

			
				
SpringBoot+Mybatis+CXF框架，实现Restful api与 WebService api接口的大实验  本实验的主要目标是使用SpringBoot、Mybatis和CXF框架来实现Restful API和WebService API接口的大实验。下面是实验的详细介绍：  标题...

			
		

	





	

		

			

          精选资源
				
					
RESTfulAPI:.net 5构建RESTful API，杨旭学习编码和笔记

				
			

			

				

					03-07
				

			

		

		

			
				
在.NET 5中构建RESTful API是现代Web服务开发中的常见任务，这主要得益于REST（Representational State Transfer）架构风格的广泛采纳。RESTful API设计原则强调资源的表述和状态转移，通过HTTP协议来实现客户端与...

			
		

	





	

		

			

          精选资源
				
					
RESTful API设计规范.pdf

				
			

			

				

					02-13
				

			

		

		

			
				
RESTful API设计规范.pdf  RESTful API设计规范是指在软件架构和设计风格中，遵循一组设计原则和约束条件，以降低开发的复杂性，提高系统的可扩展性。RESTful架构的核心是面向资源，每个网址代表一种资源，因此网址...

			
		

	





	

		

			

				
					
计及光伏电站快速无功响应特性的分布式电源优化配置方法（Matlab代码实现）

					
最新发布

				
			

			

				

					01-09
				

			

		

		

			
				
计及光伏电站快速无功响应特性的分布式电源优化配置方法（Matlab代码实现）内容概要：本文提出了一种计及光伏电站快速无功响应特性的分布式

			
		

	





	

		

			

				
					
ufitool-redux 旧版remo

				
			

			

				

					01-09
				

			

		

		

			
				
中兴微随身wi旧版优化跑一下切外置卡，企鹅去控1，adb离线状态就能变正常在线了。
能不能用自己看，不确保

			
		

	





	

		

			

				
					
基于 littlefs 开源协议的合规使用方案！.zip

				
			

			

				

					01-09
				

			

		

		

			
				
基于 littlefs 开源协议的合规使用方案！.zip

			
		

	





	

		

			

				
					
Java + 基于爬虫技术爬取豆瓣图书及评论数据至 MySQL！.zip

				
			

			

				

					01-09
				

			

		

		

			
				
Java + 基于爬虫技术爬取豆瓣图书及评论数据至 MySQL！.zip

			
		

	





	

		

			

				
					
基于STM32的应急救援仓系统.zip

				
			

			

				

					01-09
				

			

		

		

			
				
基于STM32的应急救援仓系统.zip

			
		

	





	

		

			

				
					
Restful Api

				
			

			

				

					05-30
				

			

		

		

			
				
### Restful API 使用指南与原理介绍

#### 什么是 RESTful API
REST（Representational State Transfer）是一种软件架构风格，用于设计网络应用程序。它基于 HTTP 协议，并通过标准的 HTTP 方法（如 GET、POST、PUT、DELETE 等）来操作资源[^2]。RESTful API 是符合 REST 原则的 Web API，通常使用 JSON 或 XML 格式传输数据。

#### RESTful API 的核心原则
1. **客户端-服务器分离**：客户端和服务器是独立的实体，通过 HTTP 协议进行通信。
2. **无状态性**：每个请求必须包含所有必要的信息，服务器不会保存客户端的状态。
3. **统一接口**：通过标准化的 URL 和 HTTP 方法访问资源。
4. **分层系统**：API 可以通过多个中间层（如缓存层、负载均衡层）进行扩展。
5. **可缓存性**：响应可以被标记为可缓存或不可缓存，从而提高性能[^2]。

#### RESTful API 的设计规范
- **资源标识**：使用名词作为资源名称，避免使用动词。例如，`/users` 表示用户集合资源。
- **HTTP 方法**：根据操作类型选择合适的 HTTP 方法：
  - `GET`：获取资源。
  - `POST`：创建新资源。
  - `PUT`：更新整个资源。
  - `PATCH`：部分更新资源。
  - `DELETE`：删除资源[^1]。
- **状态码**：返回适当的 HTTP 状态码以表明操作结果。例如：
  - `200 OK`：请求成功。
  - `201 Created`：资源已创建。
  - `400 Bad Request`：客户端请求有误。
  - `404 Not Found`：资源未找到。

#### 使用 Flask 实现 RESTful API 示例
以下是一个使用 Flask 和 Flask-RESTful 创建简单 RESTful API 的示例：

```python
from flask import Flask
from flask_restful import Api, Resource

app = Flask(__name__)
api = Api(app)

class HelloWorld(Resource):
    def get(self):
        return {"message": "Hello, World!"}, 200

api.add_resource(HelloWorld, '/')

if __name__ == '__main__':
    app.run(debug=True)
```

上述代码定义了一个简单的 API 路由 `/`，当客户端发送 `GET` 请求时，返回 `"Hello, World!"`[^3]。

#### RESTful API 的实际案例
以 GitHub API 为例，其提供了丰富的 RESTful 接口供开发者使用。例如：
- 获取当前用户信息：`GET https://api.github.com/user`[^4]。
- 创建新的授权：`POST https://api.github.com/authorizations`[^4]。

这些接口遵循 RESTful 设计原则，使用标准的 HTTP 方法和状态码。

---

			
		

	



              




          




        



    





    



      

      

        
      

      





	

		评论	
	

  

	
    

      

      

      

        
        

          
          

            

              成就一亿技术人!
            

            

              拼手气红包6.0元
            

          

        

        

          

            还能输入1000个字符
          

          

             
          

          

            

              红包
              添加红包
            

            

              表情包
              插入表情
              

                

              

            

            

              表情包
              代码片
              

                
              

            

            

              
              
              
              
              
              
              
            

          

        

      

    

		

			

			

			

					 条评论被折叠 查看
			

			

				
			

		

	

	




  

    

      添加红包
      
    

    

      

        
        

          
          
        

        
请填写红包祝福语或标题

      

      

        
        

          
          个
        

        
红包个数最小为10个

      

      

        
        

          
          元
        

        
红包金额最低5元

      

      

        
        

          当前余额3.43元
          前往充值 >
        

      

      

        

          需支付：10.00元
        

        
        
      

    

  





  

    
    
  

  

    
    
  








  

    

      

        

          

            
            
成就一亿技术人!

          

          

        

        

          

          

            领取后你会自动成为博主和红包主的粉丝
            规则
          

        

      

      

        

          

            
              
            
            

              
hope_wisdom
 发出的红包
            

          

        

        

          

          

          

        

      

    

    

  



      
      

      
实付元

      
使用余额支付

      

        

          

            
            点击重新获取
          

        

        
扫码支付

      

      

        
          
            
          
          
        
      

      

        
        钱包余额
          0
          

            
            

              

                
抵扣说明：

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

              

            

          

      

      余额充值