使用Django框架建立符合RESTful風格的API-Python教學-PHP中文網

首頁

後端開發

Python教學

使用Django框架建立符合RESTful風格的API

Sep 28, 2023 pm 09:01 PM

restful api django

使用Django框架建立符合RESTful風格的API

隨著網路應用程式的不斷發展，建立可擴展且靈活的API已成為現代應用程式的重要組成部分。 Django框架作為一個流行的開發框架，為我們提供了一個快速且可靠的方式來建立符合RESTful風格的API。本文將介紹如何使用Django框架來建立RESTful API，並提供具體的程式碼範例。

建立Django專案和應用程式
首先，我們需要在本機環境中建立一個Django專案。使用以下命令建立一個名為"myproject"的專案。

$ django-admin startproject myproject

登入後複製

進入專案目錄並建立一個名為"api"的應用程式。

$ cd myproject
$ python manage.py startapp api

登入後複製

設定專案和應用程式
在專案的settings.py檔案中，我們需要新增"rest_framework"和"api"應用程式到INSTALLED_APPS清單中。

INSTALLED_APPS = [
    ...
    'rest_framework',
    'api',
]

登入後複製

還需要設定專案的urls.py文件，將請求路徑轉送給我們的API應用程式。

from django.urls import include, path

urlpatterns = [
    ...
    path('api/', include('api.urls')),
]

登入後複製

建立模型和序列化器
在我們的應用程式api中，我們需要先定義模型類別來表示我們API中的資源。以一篇文章為例，我們可以在models.py檔中定義一個名為"Article"的模型。

from django.db import models

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

登入後複製

接下來，我們需要在api目錄中建立一個名為serializers.py的文件，並定義一個名為"ArticleSerializer"的序列化器來將模型實例轉換為JSON。

from rest_framework import serializers
from api.models import Article

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

登入後複製

建立視圖
在api目錄中建立一個名為views.py的文件，並新增一個名為ArticleList的類別視圖來處理GET和POST請求。

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

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

登入後複製

我們也可以建立一個名為ArticleDetail的類別視圖來處理單一文章的GET、PUT和DELETE請求。

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

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

登入後複製

配置URL
在api目錄中建立一個名為urls.py的文件，並加入以下程式碼來設定路徑。

from django.urls import path
from api import views

urlpatterns = [
    path('articles/', views.ArticleList.as_view(), name='article-list'),
    path('articles/<int:pk>/', views.ArticleDetail.as_view(), name='article-detail'),
]

登入後複製

啟動服務
現在我們可以執行開發伺服器並測試我們的API了。

$ python manage.py runserver

登入後複製

測試API
使用工具如Postman或curl等，可以傳送HTTP請求來測試API。以下是一些常見的API請求範例。

取得所有文章(GET請求)：
```
GET http://localhost:8000/api/articles/
```
登入後複製
取得單一文章(GET請求)：
```
GET http://localhost:8000/api/articles/1/
```
登入後複製

建立新文章(POST請求)：

POST http://localhost:8000/api/articles/
Content-Type: application/json

{
  "title": "Hello",
  "content": "This is a test article."
}

登入後複製

更新文章(PUT請求)：

PUT http://localhost:8000/api/articles/1/
Content-Type: application/json

{
  "title": "Hello World",
  "content": "This is an updated test article."
}

登入後複製

##刪除文章(DELETE請求)：
```
DELETE http://localhost:8000/api/articles/1/
```
登入後複製
總結：
在本文中，我們介紹如何使用Django框架來建立符合RESTful風格的API。透過建立模型和序列化器、定義視圖和URL配置，我們能夠快速建立一個功能完整的API，並進行測試。這為我們建構現代Web應用和提供可擴展的服務提供了良好的基礎。使用Django框架，我們可以輕鬆處理常見的API需求，例如取得、建立、更新和刪除資源等。
（字數：1063）
以上是使用Django框架建立符合RESTful風格的API的詳細內容。更多資訊請關注PHP中文網其他相關文章！