RESTful API开发教程：使用Flask-RESTful构建API（第七阶段）

于 2024-08-08 00:02:14 发布
阅读量534 收藏 14
点赞数 4
分类专栏： Falsk学习教程 文章标签： restful flask 后端 经验分享 学习 python
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_54490473/article/details/140783575
版权

目录

RESTful API开发教程：使用Flask-RESTful构建API

1. 什么是REST和API？

1.1 REST的定义

REST（Representational State Transfer）是一种架构风格，主要用于构建分布式系统，特别是Web服务。它通过标准的HTTP协议来实现资源的创建、读取、更新和删除（CRUD）操作。

1.2 API的定义

API（Application Programming Interface）是一组定义了软件组件之间交互的规则。它允许不同的软件系统之间进行通信和数据交换。在Web中，API通常表现为通过HTTP进行的请求和响应。

1.3 RESTful API的特征

RESTful API具有以下特征：

  • 无状态性：每次请求都应包含足够的信息以处理该请求。
  • 可缓存性：响应应指明是否可缓存以提高性能。
  • 层次化系统：可以有多级代理，以提高可伸缩性和安全性。
  • 统一接口：使得不同的客户端和服务可以无缝交互。

2. Flask-RESTful简介

Flask-RESTful是Flask框架的一个扩展，旨在简化RESTful API的开发。它提供了一些工具，使得创建和管理API变得更加方便。

2.1 安装Flask和Flask-RESTful

首先，确保你已经安装了Flask和Flask-RESTful。可以使用pip命令进行安装：

pip install Flask Flask-RESTful

3. 使用Flask-RESTful构建RESTful API

3.1 创建基本的Flask应用

首先，创建一个新的Python文件（例如app.py），并导入Flask和Flask-RESTful：

from flask import Flask
from flask_restful import Api, Resource, reqparse

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

3.2 设计数据模型

在这个示例中，我们将创建一个简单的用户管理API。首先定义一个用户列表来模拟数据库：

users = []

3.3 创建用户资源

接下来，创建一个用户资源类，使用Flask-RESTful提供的Resource基类：

class User(Resource):
    def get(self, user_id):
        for user in users:
            if user['id'] == user_id:
                return user, 200
        return {"message": "User not found"}, 404

    def post(self):
        parser = reqparse.RequestParser()
        parser.add_argument('name', required=True, help="Name cannot be blank")
        parser.add_argument('email', required=True, help="Email cannot be blank")
        args = parser.parse_args()
        
        user_id = len(users) + 1  # Simulate auto-incremented ID
        new_user = {'id': user_id, 'name': args['name'], 'email': args['email']}
        users.append(new_user)
        return new_user, 201

    def put(self, user_id):
        parser = reqparse.RequestParser()
        parser.add_argument('name', required=True)
        parser.add_argument('email', required=True)
        args = parser.parse_args()
        
        for user in users:
            if user['id'] == user_id:
                user.update({'name': args['name'], 'email': args['email']})
                return user, 200
        return {"message": "User not found"}, 404

    def delete(self, user_id):
        global users
        users = [user for user in users if user['id'] != user_id]
        return {"message": "User deleted"}, 204

3.4 定义路由

使用Flask-RESTful的add_resource方法将资源与URL路由绑定：

api.add_resource(User, '/users/<int:user_id>', endpoint='user')

为了处理用户列表，也可以创建一个List资源类：

class UserList(Resource):
    def get(self):
        return users, 200

    def post(self):
        parser = reqparse.RequestParser()
        parser.add_argument('name', required=True, help="Name cannot be blank")
        parser.add_argument('email', required=True, help="Email cannot be blank")
        args = parser.parse_args()
        
        user_id = len(users) + 1
        new_user = {'id': user_id, 'name': args['name'], 'email': args['email']}
        users.append(new_user)
        return new_user, 201

并同样为它定义路由：

api.add_resource(UserList, '/users', endpoint='user_list')

3.5 启动应用

最后，添加以下代码以启动Flask应用：

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

3.6 完整代码

完整的代码如下：

from flask import Flask
from flask_restful import Api, Resource, reqparse

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

users = []

class User(Resource):
    def get(self, user_id):
        for user in users:
            if user['id'] == user_id:
                return user, 200
        return {"message": "User not found"}, 404

    def post(self):
        parser = reqparse.RequestParser()
        parser.add_argument('name', required=True, help="Name cannot be blank")
        parser.add_argument('email', required=True, help="Email cannot be blank")
        args = parser.parse_args()
        
        user_id = len(users) + 1
        new_user = {'id': user_id, 'name': args['name'], 'email': args['email']}
        users.append(new_user)
        return new_user, 201

    def put(self, user_id):
        parser = reqparse.RequestParser()
        parser.add_argument('name', required=True)
        parser.add_argument('email', required=True)
        args = parser.parse_args()
        
        for user in users:
            if user['id'] == user_id:
                user.update({'name': args['name'], 'email': args['email']})
                return user, 200
        return {"message": "User not found"}, 404

    def delete(self, user_id):
        global users
        users = [user for user in users if user['id'] != user_id]
        return {"message": "User deleted"}, 204

class UserList(Resource):
    def get(self):
        return users, 200

    def post(self):
        parser = reqparse.RequestParser()
        parser.add_argument('name', required=True, help="Name cannot be blank")
        parser.add_argument('email', required=True, help="Email cannot be blank")
        args = parser.parse_args()
        
        user_id = len(users) + 1
        new_user = {'id': user_id, 'name': args['name'], 'email': args['email']}
        users.append(new_user)
        return new_user, 201

api.add_resource(User, '/users/<int:user_id>', endpoint='user')
api.add_resource(UserList, '/users', endpoint='user_list')

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

4. 测试API

通过使用API测试工具，如Postman或cURL，您可以进行实际的请求。

4.1 创建用户

用POST请求创建一个用户：

curl -X POST http://127.0.0.1:5000/users -H "Content-Type: application/json" -d '{"name": "John Doe", "email": "john@example.com"}'

4.2 获取用户列表

发送GET请求获取所有用户：

curl -X GET http://127.0.0.1:5000/users

4.3 获取单个用户

获取特定用户（假设ID为1）：

curl -X GET http://127.0.0.1:5000/users/1

4.4 更新用户信息

使用PUT方法更新用户（假设ID为1）：

curl -X PUT http://127.0.0.1:5000/users/1 -H "Content-Type: application/json" -d '{"name": "Updated Name", "email": "updated@example.com"}'

4.5 删除用户

用DELETE请求删除特定用户（假设ID为1）：

curl -X DELETE http://127.0.0.1:5000/users/1

5. 处理HTTP状态码和错误响应

在代码中，我们已经通过返回相应的HTTP状态码来处理错误，例如：

  • 404（未找到用户）
  • 201（用户创建成功）
  • 204（用户删除成功）

可以根据需求添加更多的错误处理逻辑和状态码返回。

6. 结论

通过本教程，您学习了如何使用Flask和Flask-RESTful库构建RESTful API。我们讨论了REST的原则，创建API资源，返回JSON数据，以及如何处理HTTP状态码和错误响应。该示例提供了基本的用户管理功能，您可以在此基础上扩展功能，比如数据库集成、用户认证等。希望这篇文章对您的RESTful API开发之路有所帮助！

蜡笔小新星
关注
  • 4
    点赞
  • 踩
  • 14
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
如何使用Flask-RESTful来构建RESTful API
2301_78316786的博客
07-26 263
Flask-RESTful是基于Flask的，它为创建RESTful API提供了一些方便的工具和扩展。要使用Swagger，请确保安装了flask-restful-swagger库，并在代码中添加相应的注释。通过使用Flask-RESTful，你可以快速创建具有多种功能的API，从而满足不同的需求。在Flask-RESTful中，我们使用Resource函数来定义API的路由和视图。这个例子展示了如何使用Flask-RESTful创建具有多种功能的API，包括处理URL参数、返回不同的状态码和数据等等。
flask-restful-mongodb-api:使用 Flask-restful 和 MongoDB 的 REST api
06-09
烧瓶-restful-mongodb-api 使用 Flask-restful 和 MongoDB 的 REST api安装要求： 在虚拟环境中安装需求。 pip install -r requirements.txt测试api Api 可以通过多种方式进行测试。 Python模块示例：In [1]: from ...
Flask教程6：使用Flask-restful构建restful API
Cachel Wood的博客
06-08 607
首先，提供了一致的API设计方式。它采用了一种简洁而直观的方式来定义路由和处理请求。通过使用装饰器或类视图，开发人员可以轻松地将URL映射到相应的处理函数上。这种设计方式使得API的结构更加清晰，易于理解和维护。其次，简化了请求处理的过程。它提供了一系列的请求解析器，可以自动解析请求中的数据并将其转换为适当的数据类型。这样，开发人员就不需要手动解析请求参数，而是可以直接使用解析后的数据进行业务逻辑的处理。除了上述功能之外，还提供了其他一些有用的功能。
Flask教程7：Flask-Restful-Swagger使用
Cachel Wood的博客
06-08 352
是一个基于Flask和Swagger的扩展，它使得在Python中设计、文档化和测试变得简单而直观。如果你正在寻找一种高效的方式来构建可维护且易于理解的API，那么绝对值得你一试。项目简介Flask是一个轻量级的Python Web框架，Restful则是设计API的一种理念，强调资源的表述状态转移。Swagger是一个用于设计、构建、文档化和使用的工具集。将这三者结合起来，提供了一种方便的方法来实现规范化的API设计，包括自动生成详细的API文档，并支持交互式测试。技术分析。
使用Flask-RESTful构建RESTful API
Code掘金的博客
05-15 463
Flask是一个轻量级的Python web开发框架，而Flask-RESTful是一个基于Flask的扩展，专门用于构建RESTful API。在本文中，我们将介绍如何使用Flask-RESTful来构建一个简单的RESTful API。Flask-RESTful是一个非常有用的工具，使得构建RESTful API变得更加简单和高效。接下来，我们需要创建一个资源类，该类将处理API的不同请求。这里，我们创建了一个新的Flask应用和一个Flask-RESTful的实例。最后，我们需要使用Flask的。
从 Flask-RESTful 到 Flask-RESTPlus 再到 Flask-RESTX
极客点儿
01-10 3227
Django 和 Flask 一直都是 Python 开发 Web 的首选，而 Flask 的微内核更适用于现在的云原生微服务框架。但是 Flask 只是一个微型的 Web 引擎，所以我们需要扩展 Flask 使其发挥出更强悍的功能。 Flask-RESTful Flask-RESTful 就是 Flask 扩展中的佼佼者，它增加了对快速构建 RESTful API 的支持，将 Flask 封装了一层，使其更容易、更快速、更便捷的开发 RESTful API。 GitHub：https://github.
【flask】已解决:使用flask-restful后errorhandler中间件无法拦截报错
qq_42455809的博客
10-14 674
解决flask-restful中间件无法拦截报错
python flask接口开发教程_Python中Flask-RESTful编写API接口(小白入门)
weixin_39779530的博客
12-09 1011
1.API接口:hello world 案例from flask import Flaskfrom flask_restful import Api, Resourceapp = Flask(__name__)api = Api(app)class HelloWorld(Resource):def get(self):return {"hello": "world"}api.add_resourc...
Flask-RESTFul API
FatPuffer
03-27 4435
使用 pip 安装 Flask-RESTful: pip install flask-restful 开发的版本可以从 GitHub 上的页面 下载 git clone https://github.com/twilio/flask-restful.git cd flask-restful python setup.py develop 一个最小的 API from flask impor...
基于Flask的RESTful API实战代码：集成Flask-SQLAlchemy与MySQL
03-25
项目概述：本项目是一个基于Python语言的实战项目，使用了Flask框架构建RESTful API。它集成了Flask-SQLAlchemy作为ORM工具与MySQL数据库进行交互。项目共包含39个文件，其中主要的Python脚本文件有23个，辅助配置...
Python-RESTful-Api:Python Flask1.0.x构建可扩展的RESTful API
05-04
Python Flask1.0.x构建可扩展的RESTful API Python Flask构建可扩展的RESTdul API 目录结构 ├─app 框架系统目录 │ ├─api 核心接口目录 │ ├─config 核心配置目录 │ ├─libs 框架类库目录 │ │ ├─...
rest_api_demo:基于Flask-RESTPlus的RESTful API的样板代码
05-05
`rest_api_demo`项目展示了如何使用Flask-RESTPlus构建一个简单的RESTful API，包括设置API、定义资源、处理请求和响应以及启用Swagger文档。这只是一个基础示例，实际项目中可能涉及更复杂的业务逻辑、数据库操作、...
safrs：SqlAlchemy Flask-Restful Swagger Json：API OpenAPI
02-03
SAFRS：Python OpenAPI和JSON：API框架总览SAFRS是对于s QL甲lchemy˚Flask-řestful小号wagger的缩写。 这个框架的目的是帮助python开发人员为sqlalchemy数据库对象和关系创建一个自文档化的JSON API。 这些对象...
C语言学习
lovemelater618的博客
08-03 879
C语言学习
操作系统真象还原：遍历目录
最新发布
Adward的博客
08-05 367
比如该目录文件下目录项分布：a，空，b，空，c，第一次调用返回a，第二次调用返回b，第三次调用返回c…功能类似，只不过是针对目录的，避免了将目录先关闭再重新打开的繁琐。遍历目录就是读取目录中所有的目录项，在遍历之前必须要先把目录打开，之后还需要把目录关闭。遍历目录的操作中，经常会用到目录回绕的功能，也就是使目录的“游标”，成功后返回目录指针，失败返回 NULL。：接受 1 个参数，目录指针曲，功能是读取目录。读取目录实际上就是读取目录中的目录项。，成功返回 1 个目录项，失败返回。我们也按照此形式实现。
基于 Gunicorn + Flask + Docker 模型的高并发部署
qq_42072014的博客
08-04 677
本文介绍了如何使用 Gunicorn、Flask 和 Docker 来构建一个高并发的应用部署方案。通过使用 Gunicorn 来运行 Flask 应用，并使用 Docker 容器化应用，你可以轻松地将应用部署到不同的环境中，同时保证了应用的可伸缩性和稳定性。希望这篇技术博客对你有所帮助！如果你有任何疑问或想要了解更多细节，请随时留言交流！
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值