使用Python构建RESTful API的最佳实践【第137篇—RESTful API】

news2024/10/7 18:26:53

👽发现宝藏

前些天发现了一个巨牛的人工智能学习网站，通俗易懂，风趣幽默，忍不住分享一下给大家。【点击进入巨牛的人工智能学习网站】。

使用Python构建RESTful API的最佳实践

在当今的软件开发中，构建RESTful API已经成为了一种常见的做法，因为它们提供了一种简单而灵活的方式来实现客户端和服务器之间的通信。Python作为一种流行的编程语言，拥有丰富的库和框架来支持RESTful API的构建。本文将介绍使用Python构建RESTful API的最佳实践，包括选择合适的框架、设计良好的API结构以及处理常见的问题。

选择合适的框架

在Python中，有许多框架可供选择，用于构建RESTful API。其中最流行的包括Flask和Django。Flask是一个轻量级的框架，提供了灵活性和简洁性，适合构建小型和中型的API。而Django则是一个功能强大的全栈框架，提供了许多内置的功能，适合构建大型和复杂的API。

使用Flask构建RESTful API
from flask import Flask, jsonify, request

app = Flask(__name__)

tasks = [
    {"id": 1, "title": "Task 1", "description": "This is task 1", "done": False},
    {"id": 2, "title": "Task 2", "description": "This is task 2", "done": False},
]

@app.route('/tasks', methods=['GET'])
def get_tasks():
    return jsonify({'tasks': tasks})

@app.route('/tasks/<int:task_id>', methods=['GET'])
def get_task(task_id):
    task = next((task for task in tasks if task['id'] == task_id), None)
    if task:
        return jsonify({'task': task})
    else:
        return jsonify({'message': 'Task not found'}), 404

if __name__ == '__main__':
    app.run(debug=True)
使用Django构建RESTful API
from django.http import JsonResponse
from django.views.decorators.csrf import csrf_exempt
from rest_framework.decorators import api_view
from rest_framework.response import Response

tasks = [
    {"id": 1, "title": "Task 1", "description": "This is task 1", "done": False},
    {"id": 2, "title": "Task 2", "description": "This is task 2", "done": False},
]

@api_view(['GET'])
def get_tasks(request):
    return Response({'tasks': tasks})

@api_view(['GET'])
def get_task(request, task_id):
    task = next((task for task in tasks if task['id'] == task_id), None)
    if task:
        return Response({'task': task})
    else:
        return Response({'message': 'Task not found'}, status=404)

设计良好的API结构

构建良好的API结构对于客户端和服务器之间的通信至关重要。以下是一些设计良好的API结构的最佳实践：

  • 使用有意义的URL：URL应该简洁明了，并且能够清晰地表达资源的层级关系和操作。
  • 使用HTTP动词：使用HTTP动词（GET、POST、PUT、DELETE等）来表示对资源的操作，使API的行为更具语义化。
  • 使用HTTP状态码：使用适当的HTTP状态码来表示请求的结果，如200表示成功，404表示资源未找到，500表示服务器错误等。
  • 使用版本控制：在API的URL中包含版本号，以便在未来进行更新和扩展时能够向后兼容。

处理常见的问题

在构建RESTful API时，可能会遇到一些常见的问题，如身份验证、数据验证、错误处理等。以下是一些处理这些问题的最佳实践：

  • 身份验证和授权：使用JWT（JSON Web Token）或OAuth等身份验证机制来保护API，确保只有授权用户才能访问受保护的资源。
  • 数据验证：在处理请求数据之前进行数据验证，以确保数据的完整性和一致性，可以使用Flask-WTF或Django REST framework等库来实现数据验证。
  • 错误处理：在API中实现统一的错误处理机制，对于常见的错误情况（如资源未找到、权限不足等），返回适当的HTTP状态码和错误信息，以便客户端能够正确处理错误情况。

在构建RESTful API时，遵循这些最佳实践可以帮助开发人员设计出高效、可靠且易于使用的API，从而提高开发效率和用户体验。

通过本文的介绍，你可以了解到如何使用Python构建RESTful API的最佳实践，包括选择合适的框架、设计良好的API结构以及处理常见的问题。希望这些内容能够帮助你更好地构建和管理RESTful API，并提升你的开发效率和用户体验。

数据库集成和ORM

在构建RESTful API时，通常需要与数据库进行交互来存储和检索数据。Python提供了许多优秀的ORM（对象关系映射）库，如SQLAlchemy和Django ORM，用于简化与数据库的交互过程。

使用SQLAlchemy进行数据库集成
from flask import Flask, jsonify, request
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///database.db'
db = SQLAlchemy(app)

class Task(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    title = db.Column(db.String(100), nullable=False)
    description = db.Column(db.String(200), nullable=False)
    done = db.Column(db.Boolean, default=False)

@app.route('/tasks', methods=['GET'])
def get_tasks():
    tasks = Task.query.all()
    return jsonify({'tasks': [{'id': task.id, 'title': task.title, 'description': task.description, 'done': task.done} for task in tasks]})

if __name__ == '__main__':
    app.run(debug=True)
使用Django ORM进行数据库集成
from django.db import models
from rest_framework import serializers

class Task(models.Model):
    title = models.CharField(max_length=100)
    description = models.CharField(max_length=200)
    done = models.BooleanField(default=False)

class TaskSerializer(serializers.ModelSerializer):
    class Meta:
        model = Task
        fields = ['id', 'title', 'description', 'done']

单元测试

编写单元测试对于确保API的正确性和稳定性至关重要。Python提供了许多测试框架，如unittest和pytest，用于编写和执行单元测试。

使用pytest进行单元测试
import pytest
from app import app, db, Task

@pytest.fixture
def client():
    app.config['TESTING'] = True
    with app.test_client() as client:
        with app.app_context():
            db.create_all()
            yield client
            db.session.remove()
            db.drop_all()

def test_get_tasks(client):
    response = client.get('/tasks')
    assert response.status_code == 200
    assert response.json == {'tasks': []}

def test_create_task(client):
    response = client.post('/tasks', json={'title': 'Task 1', 'description': 'This is task 1'})
    assert response.status_code == 201
    assert Task.query.count() == 1

日志记录和性能优化

在构建RESTful API时，良好的日志记录对于跟踪和调试问题至关重要，而性能优化则可以提高API的响应速度和稳定性。

日志记录
import logging

logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)

@app.route('/tasks', methods=['GET'])
def get_tasks():
    logger.info('Fetching tasks')
    tasks = Task.query.all()
    return jsonify({'tasks': [{'id': task.id, 'title': task.title, 'description': task.description, 'done': task.done} for task in tasks]})
性能优化
  • 使用缓存：对于频繁访问但不经常变化的数据，可以使用缓存来提高访问速度，如使用Redis进行缓存。
  • 异步处理：对于耗时的操作，如发送邮件或处理大量数据，可以使用异步任务队列，如Celery，来提高性能。
  • 数据库索引：对于频繁查询的字段，可以添加索引来加快查询速度。
  • 垃圾回收和资源释放：及时释放不再使用的资源，避免内存泄漏和性能下降。

API文档和版本控制

良好的API文档可以帮助用户快速了解API的用法和功能，而版本控制可以确保API的向后兼容性和稳定性。

使用Swagger进行API文档自动生成
from flasgger import Swagger

app = Flask(__name__)
Swagger(app)

@app.route('/tasks', methods=['GET'])
def get_tasks():
    """Endpoint to get all tasks
    ---
    responses:
      200:
        description: A list of tasks
    """
    tasks = Task.query.all()
    return jsonify({'tasks': [{'id': task.id, 'title': task.title, 'description': task.description, 'done': task.done} for task in tasks]})
版本控制
@app.route('/v1/tasks', methods=['GET'])
def get_tasks_v1():
    tasks = Task.query.all()
    return jsonify({'tasks': [{'id': task.id, 'title': task.title, 'description': task.description, 'done': task.done} for task in tasks]})

安全性和权限管理

在构建RESTful API时，确保数据的安全性和权限管理是至关重要的。以下是一些保障API安全的最佳实践：

跨站点请求伪造（CSRF）保护
from flask_wtf.csrf import CSRFProtect

app = Flask(__name__)
csrf = CSRFProtect(app)
跨域资源共享（CORS）设置
from flask_cors import CORS

CORS(app, resources={r"/*": {"origins": "*"}})
访问控制
from flask_httpauth import HTTPBasicAuth

auth = HTTPBasicAuth()

@auth.verify_password
def verify_password(username, password):
    # 根据用户名和密码验证用户的身份
    if username == 'admin' and password == 'admin':
        return True
    return False

@app.route('/tasks', methods=['GET'])
@auth.login_required
def get_tasks():
    tasks = Task.query.all()
    return jsonify({'tasks': [{'id': task.id, 'title': task.title, 'description': task.description, 'done': task.done} for task in tasks]})

异常处理和错误信息返回

良好的异常处理和错误信息返回可以提高API的健壮性和用户体验。

@app.errorhandler(404)
def not_found(error):
    return jsonify({'error': 'Not found'}), 404

@app.errorhandler(500)
def internal_error(error):
    return jsonify({'error': 'Internal server error'}), 500

使用Gunicorn和Nginx进行部署

# 安装Gunicorn
pip install gunicorn

# 安装Nginx
sudo apt-get install nginx

# 在Gunicorn中运行应用
gunicorn -w 4 -b 127.0.0.1:8000 app:app

# 配置Nginx反向代理
server {
    listen 80;
    server_name example.com;

    location / {
        proxy_pass http://127.0.0.1:8000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }
}

日志记录和性能优化

在构建RESTful API时，良好的日志记录对于跟踪和调试问题至关重要，而性能优化则可以提高API的响应速度和稳定性。

日志记录
import logging

logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)

@app.route('/tasks', methods=['GET'])
def get_tasks():
    logger.info('Fetching tasks')
    tasks = Task.query.all()
    return jsonify({'tasks': [{'id': task.id, 'title': task.title, 'description': task.description, 'done': task.done} for task in tasks]})
性能优化
  • 使用缓存：对于频繁访问但不经常变化的数据，可以使用缓存来提高访问速度，如使用Redis进行缓存。
  • 异步处理：对于耗时的操作，如发送邮件或处理大量数据，可以使用异步任务队列，如Celery，来提高性能。
  • 数据库索引：对于频繁查询的字段，可以添加索引来加快查询速度。
  • 垃圾回收和资源释放：及时释放不再使用的资源，避免内存泄漏和性能下降。

API文档和版本控制

良好的API文档可以帮助用户快速了解API的用法和功能，而版本控制可以确保API的向后兼容性和稳定性。

使用Swagger进行API文档自动生成
from flasgger import Swagger

app = Flask(__name__)
Swagger(app)

@app.route('/tasks', methods=['GET'])
def get_tasks():
    """Endpoint to get all tasks
    ---
    responses:
      200:
        description: A list of tasks
    """
    tasks = Task.query.all()
    return jsonify({'tasks': [{'id': task.id, 'title': task.title, 'description': task.description, 'done': task.done} for task in tasks]})
版本控制
@app.route('/v1/tasks', methods=['GET'])
def get_tasks_v1():
    tasks = Task.query.all()
    return jsonify({'tasks': [{'id': task.id, 'title': task.title, 'description': task.description, 'done': task.done} for task in tasks]})

总结：

本文介绍了使用Python构建RESTful API的最佳实践，涵盖了多个关键方面，包括框架选择、API设计、安全性、日志记录、性能优化、API文档和版本控制等。通过选择合适的框架（如Flask或Django）以及设计良好的API结构，开发人员可以快速构建出稳健、高效的API。在保障API安全性方面，本文提供了CSRF保护、CORS设置、访问控制等方法。同时，良好的日志记录和性能优化可以帮助开发人员更好地跟踪和调试问题，并提高API的响应速度和稳定性。此外，使用Swagger进行API文档自动生成和版本控制可以帮助用户更好地了解API的功能和用法，并确保API的向后兼容性和稳定性。综上所述，遵循本文提出的最佳实践，开发人员可以构建出安全、稳定且易于使用的RESTful API，提高开发效率和用户体验。

在这里插入图片描述

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1524638.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

【系统性】 循序渐进学C++

【系统性】 循序渐进学C++

循序渐进学C 第一阶段&#xff1a;基础 一、环境配置 1.1.第一个程序&#xff08;基本格式&#xff09; ​ #include <iosteam> using namespace std;int main(){cout<<"hello world"<<endl;system("pause"); }​ 模板 #include &…
阅读更多...
【开源鸿蒙】编译OpenHarmony轻量系统QEMU RISC-V版

【开源鸿蒙】编译OpenHarmony轻量系统QEMU RISC-V版

文章目录 一、背景介绍二、准备OpenHarmony源代码三、准备hb命令3.1 安装hb命令3.2 检查hb命令 四、编译RISC-V架构的OpenHarmony轻量系统4.1 设置hb构建目标4.2 启动hb构建过程 五、问题解决5.1 hb set 报错问题解决 六、参考链接 开源鸿蒙坚果派&#xff0c;学习鸿蒙一起来&a…
阅读更多...
【开源】SpringBoot框架开发二手车交易系统

【开源】SpringBoot框架开发二手车交易系统

目录 一、摘要1.1 项目介绍1.2 项目录屏 二、功能模块2.1 数据中心模块2.2 二手车档案管理模块2.3 车辆预约管理模块2.4 车辆预定管理模块2.5 车辆留言板管理模块2.6 车辆资讯管理模块 三、系统设计3.1 E-R图设计3.2 可行性分析3.2.1 技术可行性分析3.2.2 操作可行性3.2.3 经济…
阅读更多...
HarmonyOS NEXT应用开发—发布图片评论

HarmonyOS NEXT应用开发—发布图片评论

介绍 本示例将通过发布图片评论场景&#xff0c;介绍如何使用startAbilityForResult接口拉起相机拍照&#xff0c;并获取相机返回的数据。 效果图预览 使用说明 通过startAbilityForResult接口拉起相机&#xff0c;拍照后获取图片地址。 实现思路 创建CommentData类&#…
阅读更多...
vue ui 无反应解决方法

vue ui 无反应解决方法

cmd 输入vue ui 无反应解决方法 在学习vuex的过程中&#xff0c;需要用到vue ui 建立项目&#xff0c;遇到的问题记录一下&#xff0c;希望能够以帮助有问题的其他人 查看vue版本 vue --version 或者 vue -V 发现vue版本才2.9.6 由于vue ui 命令需要vue3.0以上&#xff0c;…
阅读更多...
如何实现图片上传至服务器

如何实现图片上传至服务器

在绝大多数的项目中都会涉及到文件上传等&#xff0c;下面我们来说一下技术派中是如何实现原生图片上传的&#xff0c;这个功能说起来简单&#xff0c;但其实对于技术还是有考验的。图片的上传涉及到IO读写&#xff0c;一个文件上传的功能&#xff0c;就可以把IO流涉及到的知识…
阅读更多...
Docker学习之数据管理（超详解析）

Docker学习之数据管理（超详解析）

Docker存储资源类型&#xff1a; 用户在使用 Docker 的过程中&#xff0c;势必需要查看容器内应用产生的数据&#xff0c;或者需要将容器内数据进行备份&#xff0c;甚至多个容器之间进行数据共享&#xff0c;这必然会涉及到容器的数据管理&#xff1a; &#xff08;1&#xff…
阅读更多...
网络安全之DDos攻击原理与防御

网络安全之DDos攻击原理与防御

DDos简介 对于DDos(分布式拒绝服务)攻击&#xff0c;人们往往谈虎色变。它被认为是安全领域中最难解决的问题之一&#xff0c;迄今为止也没有完美的解决方案。DDos攻击是一种网络攻击方式&#xff0c;其目的是通过利用大量的互联网连接设备同时向目标网站或服务发送大量请求&a…
阅读更多...
字母异位词分组【每日一题】

字母异位词分组【每日一题】

可以通过案例找到规律&#xff0c;每个词排序完后是同一个&#xff0c;所以通过hasmap存储排序过的值做key&#xff0c;值是存储单词集合。 package HasTable;import java.util.*;class Solution {static List<List<String>> groupAnagrams(String[] strs) {Map&l…
阅读更多...
UnityShader（十六）凹凸映射

UnityShader（十六）凹凸映射

前言&#xff1a; 纹理的一种常见应用就是凹凸映射&#xff08;bump mapping&#xff09;。凹凸映射目的就是用一张纹理图来修改模型表面的法线&#xff0c;让模型看起来更加细节&#xff0c;这种方法不会改变模型原本的顶点位置&#xff08;也就是不会修改模型的形状&#xf…
阅读更多...
《论文阅读》E-CORE：情感相关性增强的移情对话生成 EMNLP 2023

《论文阅读》E-CORE：情感相关性增强的移情对话生成 EMNLP 2023

《论文阅读》E-CORE：情感相关性增强的移情对话生成 EMNLP 2023 前言摘要模型架构图构建边的构建和初始化节点的初始化图更新情感相关性加强解码损失函数总结前言 亲身阅读感受分享，细节画图解释，再也不用担心看不懂论文啦~ 无抄袭，无复制，纯手工敲击键盘~ 今天为大家带来…
阅读更多...
Django验证码(一）

Django验证码(一）

一、介绍 1.1、概述 验证码（CAPTCHA）是“Completely Automated Public Turing test to tell Computers and Humans Apart”（全自动区分计算机和人类的图灵测试）的缩写，是一种区分用户是计算机还是人的公共全自动程序 可以防止：恶意破解密码、刷票、论坛灌水，有效防止某…
阅读更多...
@Valid 和 @Validated 区别和使用方法

@Valid 和 @Validated 区别和使用方法

1、相关依赖 Valid 依赖包 <dependency><groupId>javax.validation</groupId><artifactId>validation-api</artifactId> </dependency>Validated的依赖包 <dependency> <groupId>org.springframework</groupId> <…
阅读更多...
学习JavaEE的日子 Day27 手撕HashMap底层原理

学习JavaEE的日子 Day27 手撕HashMap底层原理

Day27 1.手撕HashMap底层原理(重点) public class Test01 {public static void main(String[] args) {// Float float1 new Float("0.0f"); // Float float2 new Float("0.0f"); // Float result float1/float2; // System.out.println(result);/…
阅读更多...
【论文阅读】DiffSpeaker: Speech-Driven 3D Facial Animation with Diffusion Transformer

【论文阅读】DiffSpeaker: Speech-Driven 3D Facial Animation with Diffusion Transformer

DiffSpeaker: 使用扩散Transformer进行语音驱动的3D面部动画 code&#xff1a;GitHub - theEricMa/DiffSpeaker: This is the official repository for DiffSpeaker: Speech-Driven 3D Facial Animation with Diffusion Transformer paper&#xff1a;https://arxiv.org/pdf/…
阅读更多...
【SQL】1174. 即时食物配送 II （窗口函数row_number； group by写法；对比；定位错因）

【SQL】1174. 即时食物配送 II （窗口函数row_number； group by写法；对比；定位错因）

前述 推荐学习&#xff1a; 通俗易懂的学会&#xff1a;SQL窗口函数 题目描述 leetcode题目&#xff1a;1174. 即时食物配送 II 写法一&#xff1a;窗口函数 分组排序&#xff08;以customer_id 分组&#xff0c;按照order_date 排序&#xff09;&#xff0c;窗口函数应用。…
阅读更多...
从零自制docker-4-【PID Namespace MOUNT Namespace】

从零自制docker-4-【PID Namespace MOUNT Namespace】

文章目录 PID namespace代码mountnamespace通俗理解代码 PID namespace 每个命名空间都有独立的PID空间&#xff0c;即每个命名空间的进程都由一开始分配。 新建立的进程内部进程ID为1 代码 package main import ("log""os/exec""os""sy…
阅读更多...
pyspark基础 -- DataFrame的理解与案例

pyspark基础 -- DataFrame的理解与案例

DataFrame(df)介绍 datafram就是一个内存中的二维表结构&#xff0c;具备表结构的三个基本属性&#xff1a; 行列表结构描述 在结构层面&#xff0c;pyspark中的StructType对象描述了表结构&#xff0c;StructField对象描述了表的一个列信息&#xff1b;在数据层面&#xff…
阅读更多...
银行信息系统应用架构导论-引用

银行信息系统应用架构导论-引用

一级目录二级目录金融标准和参考文档一、银行企业级应用系统架构规划企业级应用系统架构规划《金融科技发展规划&#xff08;2022-2025年&#xff09;&#xff08;2022年1月中国人民银行印发&#xff09;》 《关于银行业保险业数字化转型的指导意见&#xff08;2022年1月中国银…
阅读更多...
【linux】CentOS查看系统信息

【linux】CentOS查看系统信息

一、查看版本号 在CentOS中&#xff0c;可以通过多种方法来查看版本号。以下是几种常用的方法&#xff1a; 使用cat命令查看/etc/centos-release文件&#xff1a; CentOS的版本信息存储在/etc/centos-release文件中。可以使用cat命令来显示该文件的内容&#xff0c;从而获得C…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023