コンテンツにスキップ

Django Ninjaの紹介——Django REST frameworkとの主な違い#

2024 iThome鉄人レース

これはDjango Ninjaチュートリアルシリーズの第3回です。

どんなツールを選ぶ前にも、私たちは通常、それが解決できる問題と、自分の要件に合っているかどうかをまず理解します。

この記事では、モダンなAPIフレームワークであるDjango Ninjaを紹介し、その起源や主な特徴を探るとともに、Django REST frameworkとの違いに焦点を当てて比較します。目的に合ったツールを選ぶための判断材料にしてください。

GitHubサンプルプロジェクト#

👉 Django-Ninja-Tutorial

Django Ninja：DjangoエコシステムにおけるFastAPI#

Django Ninjaの起源は、FastAPIと密接な関係があります。

Django Ninjaは「Django版のFastAPI」と見なすことができ、オリジナルのFastAPIよりもDjangoとより良く統合できます。

Django Ninjaの公式ドキュメントにおいて、作者であるVitaliy Kucheryaviyはなぜこのフレームワークを作ったのかを説明しています。それは、彼がDjangoプロジェクトでFastAPIを使用する際に直面したいくつかの課題、特に統合面での問題に起因しています。

そのため、彼はより適したツールを自ら作成することを決意し、そこからDjango Ninjaが誕生しました。

想像できるとおり、Django NinjaはFastAPIから大きな影響を受けています。さらに、Django REST frameworkの優れたプラクティスも数多く取り入れています。これは後発ならではの強みです！

ドキュメントには次のような一文が引用されています。これはよくある疑問です。

Django Ninja looks basically the same as FastAPI, so why not just use FastAPI?

答えは、DjangoとFastAPIの統合が完璧ではなく、Django NinjaがDjango開発者にとってより適したバージョンを提供しているからです。

Django Ninjaの特徴#

Django Ninjaのいくつかの重要な特性により、Django API開発者にとって優れた選択肢となっています。

  • APIドキュメントの自動生成： Pythonの型ヒントとPydanticを利用して、OpenAPI標準に準拠したAPIドキュメントを自動生成し、ドキュメントのメンテナンス作業量を大幅に削減します——これが私が当初Django Ninjaを選んだ最大の理由でもあります。
  • リクエスト検証とデータのシリアライズ： Pydantic BaseModelに基づいて、リクエストデータの検証やデータのシリアライズ・デシリアライズを処理し、APIの安定性とデータの正確性を確保します。
  • シンプルで効率的なAPI定義： Django NinjaはAPIのルーティングや処理ロジック（view関数）を定義するためのシンプルで分かりやすい方法を提供し、開発者が素早く使い始められるようにします。
  • Djangoとのシームレスな統合： フレームワークの設計当初からDjangoとの互換性が考慮されており、既存のDjangoプロジェクトに簡単に統合して、ORMなどのDjangoの既存機能をフルに活用できます。
  • 非同期のサポート： Django Ninjaは非同期処理をサポートしており、APIが大量のリクエストに直面した際にも、高い応答速度と処理性能を維持できます。

Django Ninjaの非同期パフォーマンスの優位性#

Django Ninjaの特徴を理解した後で、非同期へのサポートについて再度強調せざるを得ません。これは従来の同期フレームワークであるDjango REST frameworkに比べたDjango Ninjaの大きなパフォーマンスの優位性です。

django-ninja.dev

上図からわかるように、ネットワークリクエストの並行数が比較的多い状況（concurrency=50）では、Django Ninjaの処理能力がFlask + MarshmallowやDjango REST frameworkを明らかに上回っています。

非同期の利点は1つのworkerのみの場合にさらに顕著となり、これはリソースの節約とパフォーマンスの向上の両面において重要な意味を持ちます。

Django Ninjaについて理解したところで、それとDjango REST Frameworkの違いを比較してみましょう。

Django NinjaとDjango REST frameworkの主な違い#

Pythonバックエンド開発を始めたばかりでDjango REST frameworkに馴染みがない場合は、以前書いた〈Django REST frameworkチュートリアル（一）はじめに〉も参考にしてください。

記事の中では、なぜDjangoにDjango REST frameworkのようなAPIフレームワークが必要なのかについても説明しています。

Django REST frameworkとDjango Ninjaは、どちらもDjangoエコシステムの中でAPIを素早く構築するための強力なツールであり、前者の方がずっと長い歴史を持っています。

しかし、それらは設計理念や機能の実現において顕著な違いがあります。私にとっては、それらは完全に異なるツールだと言っても過言ではありません😎

以下の3つの部分で、私が個人的に考える両者の主な違いをまとめました。

設計理念#

  • Django REST framework：成熟した包括的なフレームワークとして、豊富なコンポーネントを提供します。高度なカスタマイズや複雑な機能を必要とするプロジェクトに適しており、強力なコミュニティのサポートがあります。
  • Django Ninja：シンプルさと開発スピードに焦点を当てており、モダンなPythonの特性（型ヒントなど）を活用してAPI開発プロセスを簡素化します。迅速な開発と高いパフォーマンスを追求するプロジェクトに適しています。

主な機能の違い#

  • シリアライズ：
    • Django REST framework：カスタムのシリアライザを使用し、より複雑なシリアライズ要件をサポートします。
    • Django Ninja：Pydantic BaseModelを使用してシリアライズのプロセスを簡素化しますが、Django REST frameworkほど柔軟ではないかもしれません。
  • APIドキュメントの生成：
    • Django REST framework：コードを通じてAPIドキュメントを自動生成するには追加のパッケージが必要ですが、Pydanticを使用するフレームワークほどの効果は得られません。
    • Django Ninja：OpenAPI標準に準拠したドキュメントを自動生成し、プロセスがより簡単で効率的です。
  • パフォーマンス：（同期vs非同期）
    • Django REST framework：機能が豊富である分、パフォーマンスに一定の影響が出る可能性があります。非同期はサポートしていません。
    • Django Ninja：リクエストの検証と処理において通常より速いパフォーマンスを示し、非同期もサポートしています。

コミュニティのサポートとエコシステム#

  • Django REST framework：成熟したコミュニティと大量のサードパーティ製パッケージを持ち、encodeチームによって開発とメンテナンスが行われています。
  • Django Ninja：比較的新しいフレームワークであり、コミュニティの規模は小さく、インターネット上の情報もずっと少ないです。また、主に作者一人によって開発・メンテナンスされています。

まとめ#

Django NinjaとDjango REST frameworkにはそれぞれの優位性があります。

  • 迅速な開発、高いパフォーマンス、モダンなPythonの型ヒントを重視するなら、Django Ninjaが理想的です。特に非同期処理が必要な場面に適しています。
  • もし複雑な認証や権限管理を処理する必要があり、高度にカスタマイズされたAPI検証や処理ロジックを必要とするなら、Django REST frameworkが安定的で強力な選択肢となります。

この記事の紹介を通じて、Django Ninjaに対するより明確な認識を持てたことと信じています。

今後のチュートリアルでは、Django Ninjaの各機能を掘り下げ、このモダンなAPI開発ツールを使いこなせるよう解説していきます。

ただし、その前に重要な準備があります。サンプルプロジェクトと環境設定です。ここからDjango Ninjaの学習を始めましょう。