1. PingCode智库首页
  2. 百科

python接口如何暴露给前端

Edit1 • • 百科

python接口如何暴露给前端

Python接口暴露给前端的方式包括使用Flask、Django、FastAPI等框架，通过这些框架，开发者可以创建RESTful API、使用WebSocket进行实时通信、实现跨域资源共享（CORS）等。 例如，使用Flask创建RESTful API 是一种常见且简便的方法。下面将详细介绍如何通过Flask创建一个简单的RESTful API，并将其暴露给前端。

一、使用Flask创建RESTful API

Flask是一个轻量级的Web框架，适合快速开发和小型应用。以下是使用Flask创建RESTful API的步骤：

1、安装Flask

首先，确保你已经安装了Flask。如果没有，可以通过pip进行安装：

pip install Flask

2、创建一个简单的Flask应用

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

from flask import Flask, jsonify, request


app = Flask(__name__)


示例数据


data = [


    {'id': 1, 'name': 'Item 1', 'description': 'This is item 1'},


    {'id': 2, 'name': 'Item 2', 'description': 'This is item 2'}


]


获取所有数据


@app.route('/api/items', methods=['GET'])


def get_items():


    return jsonify(data)


根据ID获取单条数据


@app.route('/api/items/<int:item_id>', methods=['GET'])


def get_item(item_id):


    item = next((x for x in data if x['id'] == item_id), None)


    return jsonify(item) if item else ('', 404)


创建新数据


@app.route('/api/items', methods=['POST'])


def create_item():


    new_item = request.get_json()


    data.append(new_item)


    return jsonify(new_item), 201


更新数据


@app.route('/api/items/<int:item_id>', methods=['PUT'])


def update_item(item_id):


    item = next((x for x in data if x['id'] == item_id), None)


    if not item:


        return ('', 404)


    updated_data = request.get_json()


    item.update(updated_data)


    return jsonify(item)


删除数据


@app.route('/api/items/<int:item_id>', methods=['DELETE'])


def delete_item(item_id):


    global data


    data = [x for x in data if x['id'] != item_id]


    return ('', 204)


if __name__ == '__main__':


    app.run(debug=True)

3、运行Flask应用

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

python app.py

默认情况下，应用会在http://127.0.0.1:5000运行。

4、测试API

你可以使用Postman或curl来测试API。例如，使用curl命令获取所有数据：

curl http://127.0.0.1:5000/api/items

二、使用Django REST framework

Django是一个功能强大的Web框架，适合开发复杂的应用。Django REST framework（DRF）是一个用于构建Web APIs的强大工具。

1、安装Django和Django REST framework

首先，确保你已经安装了Django和Django REST framework。如果没有，可以通过pip进行安装：

pip install Django djangorestframework

2、创建Django项目和应用

创建一个新的Django项目：

django-admin startproject myproject


cd myproject

创建一个新的应用：

python manage.py startapp myapp

3、配置项目

在myproject/settings.py中添加rest_framework和myapp到INSTALLED_APPS中：

INSTALLED_APPS = [


    ...


    'rest_framework',


    'myapp',


]

4、定义模型和序列化器

在myapp/models.py中定义一个简单的模型：

from django.db import models


class Item(models.Model):


    name = models.CharField(max_length=100)


    description = models.TextField()


    def __str__(self):


        return self.name

在myapp/serializers.py中创建一个序列化器：

from rest_framework import serializers


from .models import Item


class ItemSerializer(serializers.ModelSerializer):


    class Meta:


        model = Item


        fields = '__all__'

5、创建视图集和路由

在myapp/views.py中创建一个视图集：

from rest_framework import viewsets


from .models import Item


from .serializers import ItemSerializer


class ItemViewSet(viewsets.ModelViewSet):


    queryset = Item.objects.all()


    serializer_class = ItemSerializer

在myapp/urls.py中定义路由：

from django.urls import path, include


from rest_framework.routers import DefaultRouter


from .views import ItemViewSet


router = DefaultRouter()


router.register(r'items', ItemViewSet)


urlpatterns = [


    path('', include(router.urls)),


]

在myproject/urls.py中包含应用的路由：

from django.contrib import admin


from django.urls import path, include


urlpatterns = [


    path('admin/', admin.site.urls),


    path('api/', include('myapp.urls')),


]

6、运行Django项目

运行数据库迁移并启动Django项目：

python manage.py makemigrations


python manage.py migrate


python manage.py runserver

API将会在http://127.0.0.1:8000/api/items运行。

三、使用FastAPI

FastAPI是一个现代的、快速（高性能）的Web框架，用于基于Python 3.6+标准类型提示编写API。

1、安装FastAPI和Uvicorn

首先，确保你已经安装了FastAPI和Uvicorn。如果没有，可以通过pip进行安装：

pip install fastapi uvicorn

2、创建一个简单的FastAPI应用

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

from fastapi import FastAPI


from pydantic import BaseModel


from typing import Optional, List


app = FastAPI()


示例数据


class Item(BaseModel):


    id: int


    name: str


    description: Optional[str] = None


data = [


    Item(id=1, name='Item 1', description='This is item 1'),


    Item(id=2, name='Item 2', description='This is item 2')


]


获取所有数据


@app.get('/api/items', response_model=List[Item])


def get_items():


    return data


根据ID获取单条数据


@app.get('/api/items/{item_id}', response_model=Item)


def get_item(item_id: int):


    item = next((x for x in data if x.id == item_id), None)


    return item if item else ('', 404)


创建新数据


@app.post('/api/items', response_model=Item)


def create_item(item: Item):


    data.append(item)


    return item


更新数据


@app.put('/api/items/{item_id}', response_model=Item)


def update_item(item_id: int, updated_data: Item):


    item = next((x for x in data if x.id == item_id), None)


    if not item:


        return ('', 404)


    item.name = updated_data.name


    item.description = updated_data.description


    return item


删除数据


@app.delete('/api/items/{item_id}', status_code=204)


def delete_item(item_id: int):


    global data


    data = [x for x in data if x.id != item_id]


    return ('', 204)

3、运行FastAPI应用

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

uvicorn main:app --reload

默认情况下，应用会在http://127.0.0.1:8000运行。

4、测试API

你可以使用Postman或curl来测试API。例如，使用curl命令获取所有数据：

curl http://127.0.0.1:8000/api/items

四、实现跨域资源共享（CORS）

在实际项目中，前端和后端通常运行在不同的域名或端口下，这会导致跨域请求的问题。为了解决这个问题，可以使用CORS。

1、在Flask中实现CORS

你可以使用flask-cors库来实现CORS：

pip install flask-cors

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

from flask_cors import CORS


app = Flask(__name__)


CORS(app)

2、在Django中实现CORS

你可以使用django-cors-headers库来实现CORS：

pip install django-cors-headers

在myproject/settings.py中添加以下代码：

INSTALLED_APPS = [


    ...


    'corsheaders',


    ...


]


MIDDLEWARE = [


    ...


    'corsheaders.middleware.CorsMiddleware',


    ...


]


CORS_ORIGIN_ALLOW_ALL = True  # 允许所有域名进行跨域请求

3、在FastAPI中实现CORS

你可以使用fastapi.middleware.cors库来实现CORS：

pip install fastapi[all]

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

from fastapi.middleware.cors import CORSMiddleware


app = FastAPI()


app.add_middleware(


    CORSMiddleware,


    allow_origins=["*"],  # 允许所有域名进行跨域请求


    allow_credentials=True,


    allow_methods=["*"],


    allow_headers=["*"],


)

结论

通过使用Flask、Django REST framework和FastAPI等框架，你可以轻松地将Python接口暴露给前端应用。在实际项目中，你可以根据需求选择合适的框架，并通过实现跨域资源共享（CORS）来解决跨域请求的问题。无论选择哪个框架，关键在于确保API设计规范、性能优越，并且易于维护。 如果需要项目团队管理系统，可以考虑使用研发项目管理系统PingCode和通用项目协作软件Worktile，以提高团队协作效率。

相关问答FAQs：

1. 前端如何与Python接口进行通信？
前端可以使用HTTP请求与Python接口进行通信。可以通过发送GET或POST请求来获取数据或提交表单数据给Python接口。可以使用Ajax技术在不刷新页面的情况下与Python接口进行异步通信。

2. Python接口如何处理前端发送的数据？
Python接口可以使用框架如Flask或Django来处理前端发送的数据。可以使用路由来指定接口的URL，并使用请求方法来处理不同的请求类型。可以通过获取请求参数或请求体中的数据来处理前端发送的数据。

3. 如何保护Python接口免受非法访问？
为了保护Python接口免受非法访问，可以使用身份验证和授权机制。可以使用JWT（JSON Web Token）或基于会话的身份验证来验证用户身份。可以使用角色和权限来授权用户对接口的访问。另外，还可以使用防火墙和IP白名单来限制只有特定IP地址可以访问接口。

文章包含AI辅助创作，作者：Edit1，如若转载，请注明出处：https://docs.pingcode.com/baike/2643596

赞 (0)
Edit1Edit1
免费注册
电话联系

4008001024

微信咨询
微信咨询
返回顶部