Restful API

rest是一种软件架构风格,如果你们的接口是 rest接口,那么就可被认为你们的的接口是restful的,英文名词和形容词的区别。
rest接口是围绕“资源”展开的,利用HTTP的协议,其实rest本也可以和HTTP无关,但是现在大家普遍的使用 rest都是依托于HTTP协议。HTTP 的url即资源。

RFC 3986
定义了通用的URI语法:
URI = scheme “😕/” authority “/” path [ “?” query ][ “#” fragment ]
scheme: 指底层用的协议,如http、https、ftp
host: 服务器的IP地址或者域名
port: 端口,http中默认80
path: 访问资源的路径,就是咱们各种web 框架中定义的route路由
query: 为发送给服务器的参数
fragment: 锚点,定位到页面的资源,锚点为资源id

RESTful API设计

URL中不能有动词
在Restful架构中,每个网址代表的是一种资源,所以网址中不能有动词,只能有名词,动词由HTTP的 get、post、put、delete 四种方法来表示。

URL结尾不应该包含斜杠“/”,正斜杠(/)不会增加语义值,且可能导致混淆,REST API不允许一个尾部的斜杠,不应该将它们包含在提供给客户端的链接的结尾处

URL路径中首选小写字母

### 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、付费专栏及课程。

余额充值