django ninja

^ 請閱讀^

快速學習、快速編碼、快速運行

Django Ninja - 快速 Django REST 框架

Django Ninja是一個 Web 框架，用於使用Django和 Python 3.6+類型提示建立 API。

主要特點：

• 簡單：設計易於使用且直覺。
• 快速執行：由於Pydantic和非同步支持，性能非常高。
• 快速編碼：類型提示和自動文件讓您只專注於業務邏輯。
• 基於標準：基於API的開放標準： OpenAPI （以前稱為Swagger）和JSON Schema 。
• 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 上給它 star。
• 透過 Twitter 分享
• 如果您已經在使用 django-ninja，請將您的回饋分享至 [email protected]