使用Python创建API的三种方法 - Twilio

在FastAPI 和 Django Rest Framework（DRF），并探讨如何使用它们来构建Web API。

使用 Flask 创建 API

Flask 是一个轻量级的 Python Web 框架，因其简单易用和灵活性而受到开发者的青睐。以下是使用 Flask 创建 API 的基本步骤：

1. 安装 Flask

   首先，确保您已安装 Flask。可以通过以下命令安装：

   pip install flask

2. 创建项目目录

   为您的 Flask 项目创建一个新目录，并在其中创建必要的文件结构。

3. 编写 API 代码

   在项目目录中创建一个 Python 文件（例如 app.py），并编写以下示例代码：

   from flask import Flask, jsonify

   app = Flask(__name__)   @app.route('/api', methods=['GET'])
   def get_api():
       return jsonify({"message": "Hello, Flask API!"})   if __name__ == '__main__':
       app.run(debug=True)

4. 运行应用程序

   在终端中运行以下命令启动 Flask 应用：

   python app.py

   现在，您可以通过浏览器或工具（如 Postman）访问 http://127.0.0.1:5000/api 来测试 API。

使用 FastAPI 创建 API

FastAPI 是一个现代的、快速的 Web 框架，专为构建高性能 API 而设计。以下是使用 FastAPI 创建 API 的步骤：

1. 安装 FastAPI 和 Uvicorn

   使用以下命令安装 FastAPI 和 Uvicorn（用于运行 FastAPI 应用）：

   pip install fastapi uvicorn

2. 创建项目目录

   为 FastAPI 项目创建一个新目录，并在其中创建一个 Python 文件（例如 main.py）。

3. 编写 API 代码

   在 main.py 中添加以下代码：

   from fastapi import FastAPI

   app = FastAPI()   @app.get("/api")
   def read_api():
       return {"message": "Hello, FastAPI!"}

4. 运行应用程序

   在终端中运行以下命令启动 FastAPI 应用：

   uvicorn main:app --reload

   您可以通过访问 http://127.0.0.1:8000/api 来测试 API。此外，FastAPI 提供了内置的交互式文档，您可以在 http://127.0.0.1:8000/docs 查看和测试 API。

使用 Django Rest Framework 创建 API

Django Rest Framework（DRF）是 Django 框架的一个强大扩展，专注于构建复杂的 RESTful API。以下是使用 DRF 创建 API 的步骤：

1. 安装 Django 和 DRF

   使用以下命令安装 Django 和 DRF：

   pip install django djangorestframework

2. 创建 Django 项目和应用

   在终端中运行以下命令创建一个新的 Django 项目和应用：

   django-admin startproject django_api
   cd django_api
   python manage.py startapp api

3. 定义模型

   在 api/models.py 中定义您的数据模型。例如：

   from django.db import models

   class Item(models.Model):
       name = models.CharField(max_length=100)
       description = models.TextField()

4. 创建序列化器

   在 api/serializers.py 中创建序列化器：

   from rest_framework import serializers
   from .models import Item

   class ItemSerializer(serializers.ModelSerializer):
       class Meta:
           model = Item
           fields = '__all__'

5. 编写视图

   在 api/views.py 中创建视图：

   from rest_framework.views import APIView
   from rest_framework.response import Response
   from .models import Item
   from .serializers import ItemSerializer

   class ItemView(APIView):
       def get(self, request):
           items = Item.objects.all()
           serializer = ItemSerializer(items, many=True)
           return Response(serializer.data)

6. 配置路由

   在 api/urls.py 中配置路由：

   from django.urls import path
   from .views import ItemView

   urlpatterns = [
       path('items/', ItemView.as_view(), name='item-list'),
   ]

7. 运行服务

   确保数据库迁移已完成后，运行以下命令启动 Django 开发服务器：

   python manage.py runserver

   您可以通过访问 http://127.0.0.1:8000/api/items/ 来测试 API。

总结

通过本文，我们探讨了使用 Flask、FastAPI 和 Django Rest Framework 创建 API 的基本方法。每种框架都有其独特的优势和适用场景：Flask 适合轻量级应用，FastAPI 以性能和现代特性著称，而 Django Rest Framework 则适合复杂的项目需求。根据您的项目需求选择合适的框架，将帮助您更高效地构建 API。

原文链接: https://www.twilio.com/en-us/blog/create-api-with-python