Django를 사용하여 RESTful API 구축-파이썬 튜토리얼-php.cn

Django를 사용하여 RESTful API 구축

PHPz

풀어 주다： 2023-06-17 21:29:38

원래의

1176명이 탐색했습니다.

Django는 RESTful API를 쉽게 구축할 수 있게 해주는 웹 프레임워크입니다. RESTful API는 HTTP 프로토콜을 통해 접근할 수 있는 웹 기반 아키텍처입니다. 이 문서에서는 Django REST 프레임워크를 사용하여 개발 프로세스를 단순화하는 방법을 포함하여 Django를 사용하여 RESTful API를 구축하는 방법을 다룹니다.

Django 설치

먼저 Django를 로컬에 설치해야 합니다. pip를 사용하여 Django를 설치할 수 있습니다. 구체적인 명령은 다음과 같습니다.

pip install Django

로그인 후 복사

Django 프로젝트 생성

Django를 설치한 후 다음 명령을 실행하여 Django 프로젝트를 생성할 수 있습니다.

django-admin startproject projectname

로그인 후 복사

그 중 projectname은 생성하려는 프로젝트의 이름입니다. projectname是你要创建的项目名称。

创建Django应用

Django项目由应用组成。我们需要在项目中创建应用来构建RESTful API。可以通过运行以下命令来创建应用：

python manage.py startapp appname

로그인 후 복사

其中，appname是你要创建的应用名称。

配置数据库

默认情况下，Django使用SQLite作为其默认数据库。如果你想更改数据库，可以在项目的settings.py文件中进行配置。

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': 'mydatabase',
        'USER': 'mydatabaseuser',
        'PASSWORD': 'mypassword',
        'HOST': '127.0.0.1',
        'PORT': '5432',
    }
}

로그인 후 복사

创建模型

在Django中，模型是用于维护数据的类。我们需要创建与RESTful API相关联的模型。

from django.db import models

class Article(models.Model):
    title = models.CharField(max_length=200)
    content = models.TextField()
    created_at = models.DateTimeField(auto_now_add=True)

로그인 후 복사

在这个例子中，我们创建了一个名为Article的模型，它具有title，content和created_at字段。

创建序列化器

序列化器用于将模型序列化为JSON格式，以传递给客户端。可以使用Django REST框架提供的序列化器来简化此过程。

from rest_framework import serializers
from .models import Article

class ArticleSerializer(serializers.ModelSerializer):
    class Meta:
        model = Article
        fields = ('id', 'title', 'content', 'created_at')

로그인 후 복사

在这个例子中，我们创建了一个名为ArticleSerializer的序列化器，它将Article模型序列化为包含id，title，content和created_at字段的JSON格式。

创建视图

视图用于处理HTTP请求并将响应返回给客户端。可以使用Django REST框架提供的视图类来简化此过程。

from rest_framework import generics
from .models import Article
from .serializers import ArticleSerializer

class ArticleList(generics.ListCreateAPIView):
    queryset = Article.objects.all()
    serializer_class = ArticleSerializer

class ArticleDetail(generics.RetrieveUpdateDestroyAPIView):
    queryset = Article.objects.all()
    serializer_class = ArticleSerializer

로그인 후 복사

在这个例子中，我们创建了一个视图类ArticleList和ArticleDetail。ArticleList类处理GET和POST请求，ArticleDetail类处理GET，PUT和DELETE请求。它们都使用Article模型和ArticleSerializer序列化器。

添加URL

我们需要将视图映射到URL，以便客户端可以访问RESTful API。可以在应用的urls.py文件中进行配置。

from django.conf.urls import url
from .views import ArticleList, ArticleDetail

urlpatterns = [
    url(r'^articles/$', ArticleList.as_view(), name='article-list'),
    url(r'^articles/(?P<pk>[0-9]+)/$', ArticleDetail.as_view(), name='article-detail'),
]

로그인 후 복사

在这个例子中，我们映射了ArticleList和ArticleDetail视图到URL /articles/和/articles/<pk>/。<pk>是Article模型的主键。