RestFul API

最新推荐文章于 2025-01-06 18:46:27 发布
最新推荐文章于 2025-01-06 18:46:27 发布
阅读量820 收藏 1
点赞数
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/demands/article/details/22203549 
含状态传输（英文：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 设计原则

				
			

			

				

					Mr.Phoebe的专栏
				

				

					04-10
					
					7485
					
				

			

		

		

			
				
Restful API 设计原则



前言

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

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

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

			
		

	



                

            
              



	

		

			

				
					
Restful API优雅原则统一规范

					
热门推荐

				
			

			

				

					张彦峰的博客
				

				

					10-14
					
					10万+
					
				

			

		

		

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

			
		

	



              


  
              

                


	

		

			

				
					
JEESZ RestFul服务介绍

				
			

			

				

					civtsbiqr522632413的博客
				

				

					08-03
					
					143
					
				

			

		

		

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


	1. REST介绍


	REpresentational State Tra...

			
		

	





	

		

			

				
					
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

				
			

			

				

					qq_22325611的博客
				

				

					12-10
					
					1738
					
				

			

		

		

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

			
		

	





	

		

			

				
					
Restful API

				
			

			

				

					weixin_46598480的博客
				

				

					10-11
					
					1万+
					
				

			

		

		

			
				
REST API 定义如下：一种应用程序编程接口（API 或 Web API），遵循一组关于应用程序如何使用 HTTP 方法相互通信的架构规则。RESTful Web 服务使用 REST API 协议，因此有时也称为 RESTful API。REST 通常用于构建 Web API，允许客户端与服务器之间通过 HTTP 协议进行交互。REST 是由 Roy Fielding 在 2000 年提出的一种架构风格。

			
		

	





	

		

			

				
					
RESTful API 详解

				
			

			

				

					2301_79858914的博客
				

				

					12-02
					
					1370
					
				

			

		

		

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

			
		

	





	

		

			

				
					
restful api

				
			

			

				

					fanzhe的博客
				

				

					11-14
					
					304
					
				

			

		

		

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

			
		

	





	

		

			

				
					
RestFul API 简明教程

				
			

			

				

					2403_87122707的博客
				

				

					01-06
					
					1698
					
				

			

		

		

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

			
		

	





	

		

			

				
					
RESTful api

				
			

			

				

					qq_40407998的博客
				

				

					10-28
					
					3009
					
				

			

		

		

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

			
		

	





	

		

			

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

				
			

			

				

					03-19
				

			

		

		

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

			
		

	





	

		

			

				
					
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架构的核心是面向资源，每个网址代表一种资源，因此网址...

			
		

	





	

		

			

				
					
使用窗口法和模板匹配进行心率跟踪。.zip

					
最新发布

				
			

			

				

					08-24
				

			

		

		

			
				
1.版本：matlab2014a/2019b/2024b

2.附赠案例数据可直接运行。

3.代码特点：参数化编程、参数可方便更改、代码编程思路清晰、注释明细。

4.适用对象：计算机，电子信息工程、数学等专业的大学生课程设计、期末大作业和毕业设计。

			
		

	





	

		

			

				
					
基于 Go 开发的智能运维命令行工具.zip

				
			

			

				

					08-24
				

			

		

		

			
				
基于 Go 开发的智能运维命令行工具.zip

			
		

	





	

		

			

				
					
spring-context-4.0.9.RELEASE.jar中文文档.zip

				
			

			

				

					08-24
				

			

		

		

			
				
1、压缩文件中包含：
中文文档、jar包下载地址、Maven依赖、Gradle依赖、源代码下载地址。
2、使用方法：
解压最外层zip，再解压其中的zip包，双击 【index.html】 文件，即可用浏览器打开、进行查看。
3、特殊说明：
（1）本文档为人性化翻译，精心制作，请放心使用；
（2）只翻译了该翻译的内容，如：注释、说明、描述、用法讲解 等；
（3）不该翻译的内容保持原样，如：类名、方法名、包名、类型、关键字、代码 等。
4、温馨提示：
（1）为了防止解压后路径太长导致浏览器无法打开，推荐在解压时选择“解压到当前文件夹”（放心，自带文件夹，文件不会散落一地）；
（2）有时，一套Java组件会有多个jar，所以在下载前，请仔细阅读本篇描述，以确保这就是你需要的文件。
5、本文件关键字：
jar中文文档.zip,java,jar包,Maven,第三方jar包,组件,开源组件,第三方组件,Gradle,中文API文档,手册,开发手册,使用手册,参考手册。

			
		

	





	

		

			

				
					
slf4j-simple-1.7.5.jar中文文档.zip

				
			

			

				

					08-24
				

			

		

		

			
				
1、压缩文件中包含：
中文文档、jar包下载地址、Maven依赖、Gradle依赖、源代码下载地址。
2、使用方法：
解压最外层zip，再解压其中的zip包，双击 【index.html】 文件，即可用浏览器打开、进行查看。
3、特殊说明：
（1）本文档为人性化翻译，精心制作，请放心使用；
（2）只翻译了该翻译的内容，如：注释、说明、描述、用法讲解 等；
（3）不该翻译的内容保持原样，如：类名、方法名、包名、类型、关键字、代码 等。
4、温馨提示：
（1）为了防止解压后路径太长导致浏览器无法打开，推荐在解压时选择“解压到当前文件夹”（放心，自带文件夹，文件不会散落一地）；
（2）有时，一套Java组件会有多个jar，所以在下载前，请仔细阅读本篇描述，以确保这就是你需要的文件。
5、本文件关键字：
jar中文文档.zip,java,jar包,Maven,第三方jar包,组件,开源组件,第三方组件,Gradle,中文API文档,手册,开发手册,使用手册,参考手册。

			
		

	





	

		

			

				
					
python39-scipy-1.5.4-3.module_el8.5.0+738+dc19af12.tar.gz

				
			

			

				

					08-24
				

			

		

		

			
				
# 适用操作系统：Centos8
#Step1、解压
tar -zxvf xxx.el8.tar.gz
#Step2、进入解压后的目录，执行安装
sudo rpm -ivh *.rpm

			
		

	





	

		

			

				
					
RESTFUl API

				
			

			

				

					04-28
				

			

		

		

			
				
### Restful API 的使用教程与原理介绍

#### 什么是 RESTful API？
REST（Representational State Transfer）是一种软件架构风格，用于设计网络应用程序。它基于 HTTP 协议，利用标准的 HTTP 方法（如 GET、POST、PUT 和 DELETE），来执行 CRUD（Create, Read, Update, Delete）操作[^1]。

#### RESTful API 的核心原则
1. **无状态性**：每次请求都应独立完成，服务器不应保存任何客户端的状态信息。
2. **统一接口**：通过标准化资源标识符（URI）、HTTP 动词以及媒体类型定义交互方式。
3. **分层系统**：允许中间件的存在，例如缓存代理或负载均衡器。
4. **可缓存性**：响应数据可以被标记为可缓存或不可缓存，从而减少不必要的通信开销。

#### 构建 RESTful API 的基本步骤
以下是构建一个简单 RESTful API 所需的关键要素：

1. **选择框架**
   Python 中常用的 Web 框架之一是 Flask，配合 Flask-RESTful 可快速搭建 API 应用程序[^3]。
   
   ```python
   from flask import Flask
   from flask_restful import Resource, Api
   
   app = Flask(__name__)
   api = Api(app)
   
   class HelloWorld(Resource):
       def get(self):
           return {'message': 'Hello, World!'}
       
   api.add_resource(HelloWorld, '/')
   
   if __name__ == '__main__':
       app.run(debug=True)
   ```

2. **定义资源路由**
   资源通常表示数据库中的实体，例如用户、订单等。每种资源都有对应的 URI 表示其位置，并通过不同的 HTTP 方法对其进行操作。

3. **实现字段校验**
   对于传入的数据，可以通过库如 `marshmallow` 进行字段验证，确保输入的有效性和安全性[^1]。

#### 认证机制简介
为了保护 API 不被未授权访问，在实际项目中常采用 API 密钥认证的方式。具体流程如下：
- 客户端向授权服务器申请唯一 API Key；
- 授权成功后，该 Key 将存储至数据库供后续验证；
- 后续调用时，客户端需携带此 Key 请求服务端进行身份确认[^4]。

尽管 RESTful API 提供了一套优雅的设计模式，但在某些情况下也可能存在局限性，例如复杂的业务逻辑难以完全映射到资源模型上等问题[^2]。

---

###

			
		

	



              




          




        



    





    



      

      

        
      

      





	

		评论	
	

  
	




  

    

      添加红包
      
    

    

      

        
        

          
          
        

        
请填写红包祝福语或标题

      

      

        
        

          
          个
        

        
红包个数最小为10个

      

      

        
        

          
          元
        

        
红包金额最低5元

      

      

        
        

          当前余额3.43元
          前往充值 >
        

      

      

        

          需支付：10.00元
        

        
        
      

    

  





  

    
    
  

  

    
    
  








  

    

      

        

          

            
            
成就一亿技术人!

          

          

        

        

          

          

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

        

      

      

        

          

            
              
            
            

              
hope_wisdom
 发出的红包
            

          

        

        

          

          

          

        

      

    

    

  



      
      

      
实付元

      
使用余额支付

      

        

          

            
            点击重新获取
          

        

        
扫码支付

      

      

        
          
            
          
          
        
      

      

        
        钱包余额
          0
          

            
            

              

                
抵扣说明：

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

              

            

          

      

      余额充值