django ninja

^ 必ずお読みください ^

学習もコーディングも実行も迅速です

Django Ninja - 高速な Django REST フレームワーク

Django Ninja は、 Djangoおよび Python 3.6以降のタイプ ヒントを使用して API を構築するための Web フレームワークです。

主な特徴:

• 簡単: 使いやすく直感的に使えるように設計されています。
• 高速実行: Pydanticと非同期のサポートにより、非常に高いパフォーマンスが得られます。
• コーディングが早い: 入力ヒントと自動ドキュメントにより、ビジネス ロジックのみに集中できます。
• 標準ベース: API のオープン標準: OpenAPI (以前は Swagger として知られていました) およびJSON スキーマに基づいています。
• Django フレンドリー: (当然ですが) Django コアおよび ORM との統合が良好です。
• 本番環境対応: ライブ プロジェクトで複数の企業によって使用されています (django-ninja を使用していてフィードバックを公開したい場合は、[email protected] に電子メールを送信してください)。

ドキュメント: https://django-ninja.dev

---

インストール

 pip install django-ninja

使用法

django プロジェクトの urls.py の隣に、新しいapi.pyファイルを作成します。

 from ninja import NinjaAPI

api = NinjaAPI ()


@ api . get ( "/add" )
def add ( request , a : int , b : int ):
    return { "result" : a + b }

次に、 urls.pyに移動し、以下を追加します。

...
from . api import api

urlpatterns = [
    path ( "admin/" , admin . site . urls ),
    path ( "api/" , api . urls ),  # <---------- !
]

それでおしまい ！

これで、次のような API が作成されました。

• /api/addで HTTP GET リクエストを受信します
• GET パラメータaとbを取得、検証、および型キャストします。
• 結果をJSONにデコードします
• 定義された操作の OpenAPI スキーマを生成します

インタラクティブ API ドキュメント

次に、http://127.0.0.1:8000/api/docs にアクセスします。

自動対話型 API ドキュメント (Swagger UI または Redoc によって提供) が表示されます。

次は何でしょうか？

• ここで完全なドキュメントをお読みください - https://django-ninja.dev
• このプロジェクトをサポートするには、Github でスターを付けてください。
• Twitter経由で共有してください
• すでに django-ninja を使用している場合は、[email protected] までフィードバックを共有してください。