《每天5分钟用Flask搭建一个管理系统》第9章:API设计

第9章:API设计

9.1 RESTful API的概念

RESTful API是一种基于HTTP协议的网络服务接口设计方法,它使用标准的HTTP方法,如GET、POST、PUT、DELETE等,来执行资源的操作。

9.2 Flask-RESTful扩展的使用

Flask-RESTful是一个Flask扩展,简化了创建RESTful API的过程。

示例代码:安装Flask-RESTful

bash 复制代码
pip install flask-restful

示例代码:创建API资源

python 复制代码
from flask import Flask
from flask_restful import Api, Resource, reqparse

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

class HelloWorld(Resource):
    def get(self):
        return {'hello': 'world'}

api.add_resource(HelloWorld, '/')
9.3 API路由和视图的创建

在Flask-RESTful中,资源(Resource)是API的基本单元,每个资源都映射到一个URL路由。

示例代码:添加资源到API

python 复制代码
class UserResource(Resource):
    def get(self, user_id):
        # 假设有一个函数get_user可以获取用户数据
        return get_user(user_id)

api.add_resource(UserResource, '/users/<int:user_id>')
9.4 数据序列化和反序列化

序列化是将数据结构或对象状态转换为可存储或可传输的格式的过程。反序列化是序列化相反的过程。

示例代码:使用Marshmallow序列化数据

bash 复制代码
pip install marshmallow
python 复制代码
from marshmallow import Schema, fields

class UserSchema(Schema):
    id = fields.Int()
    username = fields.Str()
    email = fields.Email()

user_schema = UserSchema()

# 序列化
data, errors = user_schema.dump(user)
# 反序列化
data, errors = user_schema.load(request.json)
9.5 API输入验证

在API开发中,验证输入数据的正确性是非常重要的。

示例代码:使用Marshmallow进行输入验证

python 复制代码
class UserSchema(Schema):
    username = fields.Str(required=True)
    email = fields.Email(required=True)

user_schema = UserSchema()

# 验证输入
result = user_schema.load(request.json)
if result.errors:
    # 处理错误
9.6 API的错误处理

在API设计中,合理的错误处理可以提供清晰的错误信息,帮助客户端开发者理解问题所在。

示例代码:自定义错误处理

python 复制代码
from flask_restful import Resource, Api, reqparse, abort

class UserResource(Resource):
    def get(self, user_id):
        if user_id == 'invalid':
            abort(404, message="User not found")
        return {'user_id': user_id}

api.add_resource(UserResource, '/users/<string:user_id>')
9.7 总结

本章介绍了RESTful API的概念,以及如何使用Flask-RESTful和Marshmallow扩展来创建API资源、序列化和反序列化数据、进行输入验证和错误处理。

相关推荐
星辰离彬30 分钟前
Java 与 MySQL 性能优化:Java应用中MySQL慢SQL诊断与优化实战
java·后端·sql·mysql·性能优化
敲键盘的小夜猫38 分钟前
LLM复杂记忆存储-多会话隔离案例实战
人工智能·python·langchain
高压锅_12201 小时前
Django Channels WebSocket实时通信实战:从聊天功能到消息推送
python·websocket·django
GetcharZp2 小时前
彻底告别数据焦虑!这款开源神器 RustDesk,让你自建一个比向日葵、ToDesk 更安全的远程桌面
后端·rust
胖达不服输2 小时前
「日拱一码」020 机器学习——数据处理
人工智能·python·机器学习·数据处理
吴佳浩2 小时前
Python入门指南-番外-LLM-Fingerprint(大语言模型指纹):从技术视角看AI开源生态的边界与挑战
python·llm·mcp
jack_yin3 小时前
Telegram DeepSeek Bot 管理平台 发布啦!
后端
小码编匠3 小时前
C# 上位机开发怎么学?给自动化工程师的建议
后端·c#·.net
库森学长3 小时前
面试官:发生OOM后,JVM还能运行吗?
jvm·后端·面试
转转技术团队3 小时前
二奢仓店的静默打印代理实现
java·后端