Djangoで他の人が呼び出せるAPIを書く方法

2年 ago
陽, 向宇
1 minute

Djangoでは、Django Rest Framework(DRF)を利用することで他人に呼び出せるAPIを作成できます。以下に、DRFを使用してユーザーの取得と作成を行うためのAPIを作成する簡単な例を示します。

  1. プロジェクトに Django と Django Rest Framework がインストールされていることを確認してください。
  2. プロジェクトの urls.py に、以下のコードを追加します。
from django.urls import path
from myapp import views

urlpatterns = [
    path('users/', views.UserList.as_view(), name='user-list'),
    path('users/<int:pk>/', views.UserDetail.as_view(), name='user-detail'),
]
  1. myapp/views.py ファイルを作成し、以下のコードを追加する
from django.contrib.auth.models import User
from rest_framework import generics
from myapp.serializers import UserSerializer

class UserList(generics.ListCreateAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer

class UserDetail(generics.RetrieveUpdateDestroyAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer
  1. myapp/serializers.py ファイルを作成し、以下を追加:
from django.contrib.auth.models import User
from rest_framework import serializers

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ['id', 'username', 'email']
  1. できれば日本語でコメントをしていただけますか。
  2. /users//

本例は簡単なサンプルです。必要に応じて修正・拡張できます。DRFは、より簡単にインターフェースを作成できるよう、多くの機能とオプションを提供しています。詳細と例については、Django Rest Frameworkの公式サイトを参照してください。

bannerAds