Share
Embed
DjangoNinjaで高速なAPI開発を実現する
Masaya
September 27, 2024
Transcript
40 slides
-
自己紹介 氏名 加藤 雅也 @mmmm70641 経歴 2021/04 ~ 2024/03 新卒で受託開発企業
2024/04 ~ Recustomer株式会社 普段はバックエンドとフロントエンドと開発に従事 -
Django Ninjaとは スター数 DjangoNinja 初回リリース日 最新リリース日 最新バージョン 約7,000 2019/12/04 2024/08/15
1.3.0 DjangoRestFramework 約28,200 2011/02/20 2024/06/19 3.15.2 pypi(https://pypi.org/)より参照 -
Django Ninjaの特徴 シンプルな設計と高速 なパフォーマンス Pydanticと非同期サポートにより、非 常に高いパフォーマンスを実現しま す。 型ヒント対応による 自動バリデーションと ドキュメント生成
型ヒントと自動ドキュメントにより、 ビジネス ロジックのみに集中できま す。 Djangoとのシームレス な統合 Djangoの機能やエコシステム (Django ORMなど)と深く統合され ています。 -
Django Ninjaの特徴 シンプルな設計と 高速なパフォーマンス Pydanticと非同期サポートにより、 非常に高いパフォーマンスを実現しま す。 型ヒント対応による 自動バリデーションと ドキュメント生成
型ヒントと自動ドキュメントにより、 ビジネス ロジックのみに集中できま す。 Djangoとのシームレス な統合 Djangoの機能やエコシステム (Django ORMなど)と深く統合され ています。 -
使いやすく直感的に操作できる FastAPI 1 from fastapi import FastAPI 2 3 api
= FastAPI() 4 5 @api.get("/users/", response_model=list[Hoge]) 6 def get_users(): 7 """ユーザーのリストを取得します""" 8 ... DjangoRestFramework 1 from rest_framework.views import APIView 2 3 class UserListAPIView(APIView): 4 """ユーザーのリストを取得します""" 5 def get(self, request): 6 ... 7 -
使いやすく直感的に操作できる DjangoNinja 1 from ninja import NinjaAPI 2 3 api
= NinjaAPI() 4 5 @api.get("/users/", response=UserOut) 6 def get_users(request): 7 """ユーザーのリストを取得します""" 8 ... 9 10 @api.get("/users/{user_id}/", response=UserOut) 11 def get_user(request, user_id: int): 12 """特定のユーザーを取得します""" 13 ... 14 15 @api.post("/users/{user_id}/", response=UserOut) 16 def create_user(request, data: UserIn): 17 """新しいユーザーを作成します""" 18 ... -
使いやすく直感的に操作できる DjangoNinja 1 from ninja import NinjaAPI 2 3 api
= NinjaAPI() 4 5 @api.get("/users/", response=UserOut) 6 def get_users(request): 7 """ユーザーのリストを取得します""" 8 ... FastAPI 1 from fastapi import FastAPI 2 3 api = FastAPI() 4 5 @api.get("/users/", response_model=list[Hoge]) 6 def get_users(): 7 """ユーザーのリストを取得します""" 8 ... -
高速なパフォーマンス 「1つのリクエストのみ処理する」という条件の場合 Django Ninja → 約750リクエスト/秒 Flask + Marshmallow →
約750リクエスト/秒 Django REST Framework → 約500リクエスト/秒 DjangoNinja Flask + Marshmallow Django REST Framework DjangoNinja公式ドキュメント(https://django-ninja.dev/guides/async-support/)から参照 -
高速なパフォーマンス DjangoNinjaの非同期ビューを使用し、並列処理で50のリクエストを処理しながら、 遅いネットワーク操作を呼び出す場合の、1秒あたりのリクエスト数を測定しています。 グラフは、使用するワーカーの数(1から24まで)による性能の違いを示しています。 DjangoNinja Flask + Marshmallow Django REST
Framework DjangoNinja公式ドキュメント(https://django-ninja.dev/guides/async-support/)から参照 -
非同期ビューを最大限に活用した高速なパフォーマンスを実現 同期処理 1 import time 2 3 # 指定された秒数だけスリープして単語を返す処理 4
@api.get("/say-after") 5 def say_after(request, delay: int, word: str): time.sleep(dalay) 6 7 return {"saying": word} 8 非同期処理 1 import asyncio 2 3 # 指定された秒数だけスリープして単語を返す処理 4 @api.get("/say-after") 5 async def say_after(request, delay: int, word: str): 6 await asyncio.sleep(dalay) 7 return {"saying": word} 8 -
Django Ninjaの特徴 高速なパフォーマンス Pydanticと非同期サポートにより、 非常に高いパフォーマンスを実現しま す。 型ヒント対応による 自動バリデーションと ドキュメント生成 型ヒントと自動ドキュメントにより、
ビジネス ロジックのみに集中できま す。 Djangoとのシームレス な統合 Djangoの機能やエコシステム (Django ORMなど)と深く統合され ています。 -
Pydanticを利用した型定義ができる Pydanticとは pythonの標準的な型ヒントを利用して、入力データが期待される型に従っているかを自動的にチェックするライブラリ 1 from pydantic import BaseModel 2 3
class User(BaseModel): 4 id: int 5 name: str 6 7 # データのインスタンス化 8 user = User(id=1, name="hoge") 9 print(user.id) # 1 10 print(user.name) # hoge 11 12 # 型が合わない場合 13 user = User(id="not number", name="hoge") 14 # -> ValidationError: id should be an integer -
Pydanticを利用した型定義ができる 1 # SchemaはpydanticのBaseModelを継承している 2 from ninja import Schema 3
4 # 禁止ワード 5 forbidden_words: list[str] = ["aaa", "iii", "uuu"] 6 7 class UserIn(Schema): username: str 8 password: str 9 10 11 # 禁止ワードがパスワードに含まれているかどうかのバリデーション 12 @validator('password') 13 def forbidden_words(cls, value): 14 for forbidden_word in forbidden_words: 15 if forbidden_word in value: 16 raise ValueError(f"Password must not contain: {forbidden}") 17 return value 18 19 @api.post("/users/") 20 def create_user(request, data: UserIn): 21 user = User(username=data.username) 22 user.set_password(data.password) 23 # ... -
Django Ninjaの特徴 高速なパフォーマンス Pydanticと非同期サポートにより、 非常に高いパフォーマンスを実現しま す。 型ヒント対応による 自動バリデーションと ドキュメント生成 型ヒントと自動ドキュメントにより、
ビジネス ロジックのみに集中できま す。 Djangoとのシームレス な統合 Djangoの機能やエコシステム (Django ORMなど)と深く統合され ています。 -
DjangoORMとのシームレスな統合 DjangoのORMをそのまま活用できるため、既存のモデルやデータベースとのやり取りがスムーズ DjangoのQuerySetやモデルインスタンスをそのまま返すことができるため、既存のDjangoアプリ ケーションのロジックを再利用しつつ、APIを簡単に作成できる 1 from django.shortcuts import get_object_or_404 2
from .models import Blog 3 from ninja import Schema 4 5 class BlogOut(Schema): 6 id: int 7 title: str 8 9 @api.get("/blog/{id}", response=BlogOut) 10 def get_blog(request, id: int): 11 """新しいユーザーを作成します""" 12 blog: Blog = get_object_or_404(Blog, id=id) 13 return blog 14 -
Djangoミドルウェアや認証システムとの互換性 DjangoNinjaはDjangoのミドルウェアや認証システムと完全に互換性があり、 例えば、既存の認証機構(DjangoのUserモデルやdjango.contrib.auth)を再利用して、APIに対して 簡単に認証・認可を導入できる 1 from ninja.security import django_auth 2
3 @api.get("/secure-data", auth=django_auth) 4 def secure_endpoint(request): 5 user = request.auth 6 ... 7 Djangoのカスタムミドルウェアもそのまま利用できるため、プロジェクトに既に導入済みのセキュ リティ、ログ、トランザクション管理などの仕組みをAPIに拡張することが可能 -
ここまでのまとめ 特徴 Django Ninja 型ヒント対応による 自動バリデーションと ドキュメント生成 Pydanticを利用した容易なバ Pydanticを利用した容易なバ 独自のバリデーションクラス
リデーション リデーション を利用するのが一般的 Djangoとのシームレスな統合 シームレスな統合が可能 シンプルな設計と 高速なパフォーマンス FastAPI REST Framework Djangoの機能を活かしつ 型ヒントを活用した直感的な Djangoの機能を活かしなが つ、型ヒントを活用した直感 開発 らAPIを構築するため 的な開発 Djangoとの統合が難しい シームレスな統合が可能 -
プロダクト 購入体験プラットフォーム Recustomer 返品キャンセル 返品キャンセルのCSおよび 倉庫業務を自動化 配送追跡 購入後の配送追跡から 新たな顧客接点を創り出す お届け日時
3月16日(水) 配達完了 配送状況 受取り日時を変更 配送業者 ヤマト運輸 追跡番号:12345678900 3月29日 配達完了 07:27 am 日本, 東京都港区 もっと見る 返品をしたい場合はこちら -
簡単なシステム構成図 認証 バックエンド 返品/キャンセル FastAPI Django フロントエンド React Next.js Django
Ninja 配送追跡 Django Django Ninja 注文管理 エンドユーザー Django Django Ninja 大量の注文 ECストア -
Fast to learn, Fast to code, Fast to run !!
早く習得でき、早くコードが書けて、早く実行できる! まるで忍者のように! -
Pycon登壇者情報 PyconJP2024にRecustomerから4名のエンジニアが登壇します! 2024年9月27日(金) 11:40 15min Django Ninjaで高速なAPI開発を実現す る:実践ガイドとベストプラクティス 加藤雅也 20F
Track2 16:40 PythonのHTTPクライアント ツール徹底比較 15min 佐藤樹 20F Track2 2024年9月28日(土) 11:10 Pythonの数学機能を学ぼう! その仕組みも学ぼう! 16:20 DjangoとFastAPIによる実践認 証技術 30min 30min 眞鍋秀悟 4F Track3 大島和樹 20F Track2