{"id":20619756,"url":"https://github.com/twtrubiks/django_ninja_tutorial","last_synced_at":"2025-10-07T06:07:15.119Z","repository":{"id":238481206,"uuid":"796646037","full_name":"twtrubiks/django_ninja_tutorial","owner":"twtrubiks","description":"django_ninja_tutorial 教學","archived":false,"fork":false,"pushed_at":"2024-09-27T12:45:49.000Z","size":21,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-15T12:11:53.127Z","etag":null,"topics":["django-ninja","django-ninja-extra","jwt"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/twtrubiks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-06T11:06:03.000Z","updated_at":"2025-02-03T02:35:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"99b10ee6-fb89-43c8-8d9b-893eff3fdef3","html_url":"https://github.com/twtrubiks/django_ninja_tutorial","commit_stats":null,"previous_names":["twtrubiks/django_ninja_tutorial"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twtrubiks%2Fdjango_ninja_tutorial","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twtrubiks%2Fdjango_ninja_tutorial/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twtrubiks%2Fdjango_ninja_tutorial/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twtrubiks%2Fdjango_ninja_tutorial/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/twtrubiks","download_url":"https://codeload.github.com/twtrubiks/django_ninja_tutorial/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249067779,"owners_count":21207396,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["django-ninja","django-ninja-extra","jwt"],"created_at":"2024-11-16T12:12:27.389Z","updated_at":"2025-10-07T06:07:15.106Z","avatar_url":"https://github.com/twtrubiks.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# django ninja 教學\n\n* [Youtube Tutorial - Django Ninja：Type Hints + Pydantic 驗證，打造 FastAPI 開發體驗！](https://youtu.be/4mPPDdVHxIg)\n\n官網介紹 [Django Ninja - Fast Django REST Framework](https://django-ninja.dev/)\n\nDjango Ninja 相對 FastAPI 的好處是可以直接無痛使用 Django 原生的 ORM,\n\n不需要像 FastAPI 那樣去決定用那套 ORM (可能用 SQLAlchemy 之類的).\n\n基本上, Django Ninja 就是在 Django 核心之上，直接添加了一層強大且易用的 API 功能.\n\n有超強的 [Pydantic 教學](https://github.com/twtrubiks/python-notes/tree/master/pydantic_tutorial) 強大驗證,\n\n也可以自動產生文件, 非常建議大家玩玩看 😄\n\n這邊寫了一些範例, 建議大家直接進去 docs 裡面看.\n\n目錄\n\n* [Ninja 使用方法](#Ninja-使用方法)\n\n* [Django Ninja Extra](#django-ninja-extra)\n\n* [Ninja JWT](#ninja-jwt)\n\n* [Sending email 搭配 Mailpit](#sending-email-搭配-mailpit---email-testing-for-developers)\n\n* [Django admin example](#django-admin-example)\n\n## Ninja 使用方法\n\n安裝 dev-containers, `\u003eDev Containers: Rebuild and Reopen in Container`\n\n如果不熟悉請參考 [Vscode Dev Containers 教學](https://github.com/twtrubiks/vscode_python_note?tab=readme-ov-file#vscode-dev-containers-%E6%95%99%E5%AD%B8)\n\n先 migrate\n\n```cmd\npython3 manage.py migrate\n```\n\n執行 django ninja\n\n```cmd\n./manage.py runserver\n```\n\n接著進入 doc [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)\n\n如果你想玩玩, 直接在這個頁面上操作即可.\n\nexample 基本上就是一些範例, 沒有和 db 互動.\n\nsheets, musics 有和 db 互動, 並且有 ORM 的操作.\n\nmusics_other 有和 db 互動, 並且有比較複雜的 ORM 操作, 以及 django ninja [Filtering](https://django-ninja.dev/guides/input/filtering/) 的用法.\n\n![alt tag](https://i.imgur.com/Ga0Hohi.png)\n\n## Django Ninja Extra\n\n[Django Ninja Extra](https://eadwincode.github.io/django-ninja-extra/)\n\n更方便定義 api, 範例如下\n\n[ninja_extra_api_tutorial](ninja_extra_api_tutorial)\n\nTHROTTLE\n\n![alt tag](https://i.imgur.com/EWr2DQ5.png)\n\n## Ninja JWT\n\n[Ninja JWT](https://eadwincode.github.io/django-ninja-jwt/)\n\n定義 JWT, 範例如下\n\n![alt tag](https://i.imgur.com/6u97gtR.png)\n\n![alt tag](https://i.imgur.com/xnWfQjW.png)\n\n如果你想要設定黑名單, 可以使用 [Blacklist App](https://eadwincode.github.io/django-ninja-jwt/blacklist_app/),\n\n使用 django admin 模擬將 refresh token 加進去黑名單, 這樣就可以強制 user 重新取 refresh token 了.\n\n或是使用 `token.blacklist()` 加入黑名單,\n\n可參考範例 `/api/auth/blacklist` 這個 api.\n\ndb 中 `token_blacklist_outstandingtoken` 紀錄 refresh token.\n\ndb 中 `token_blacklist_blacklistedtoken` 紀錄 blacklisted token.\n\n## Sending email 搭配 Mailpit - email testing for developers\n\n這部份就和 Ninja 沒關係了, 單純就是 Django 而已,\n\n一般 django 開發要寄信, 需要設定 [settings.py](https://github.com/twtrubiks/django_ninja_tutorial/blob/main/django_ninja_tutorial/settings.py)\n\n```python\nEMAIL_BACKEND = \"django.core.mail.backends.console.EmailBackend\"\n```\n\n然後去 call api `post` `/api/examples/send_email` (簡單的範例)\n\n接著看你的 console log\n\n![alt tag](https://i.imgur.com/VpsyJ3l.png)\n\n那這時候, 有沒有比較好的方式可以看這些信 ❓\n\n有的 😀\n\n就是我們要介紹的 [Mailpit - email testing for developers](https://github.com/axllent/mailpit) (UI 也不錯看 😁),\n\n[docker-compose.yml](docker-compose.yml) 這部份加上\n\n```yml\n......\n  mailpit:\n    image: axllent/mailpit\n    restart: unless-stopped\n    ports:\n       - \"8025:8025\"\n       - \"1025:1025\"\n......\n```\n\nDjango 需要修改設定 [settings.py](https://github.com/twtrubiks/django_ninja_tutorial/blob/main/django_ninja_tutorial/settings.py)\n\n```python\n# use mailpit\nEMAIL_BACKEND = \"django.core.mail.backends.smtp.EmailBackend\"\nEMAIL_HOST = \"mailpit\" # 對應 docker容器的 service\nEMAIL_PORT = 1025 # 定義為 1025\n```\n\n然後再去 call api `post` `/api/examples/send_email`\n\n然後 console log 就不會再像之前一樣顯示了, 現在會顯示在 [http://127.0.0.1:8025/](http://127.0.0.1:8025/)\n\n![alt tag](https://i.imgur.com/iZpfI3B.png)\n\n點進去也會有更詳細的資訊\n\n![alt tag](https://i.imgur.com/cug1aBW.png)\n\n## Django admin example\n\n一般的 Django 操作完全可以正常使用, 像是這邊我們來撰寫 Django [admin.py](https://github.com/twtrubiks/django_ninja_tutorial/blob/main/musics/admin.py),\n\n使用 [formfield_overrides](https://docs.djangoproject.com/en/5.1/ref/contrib/admin/#django.contrib.admin.ModelAdmin.formfield_overrides)\n\n```python\n@admin.register(Music)\nclass MusicAdmin(admin.ModelAdmin):\n    formfield_overrides = {\n        models.CharField: {\n            \"widget\": forms.TextInput(attrs={\"style\": \"width: 500px; height: 50px;\"})\n        },\n    }\n```\n\n成功覆寫了 style ( 把它拉長拉寬了 )\n\n![alt tag](https://i.imgur.com/EWuHkp5.png)\n\n## Async support\n\n* [Async support](https://django-ninja.dev/guides/async-support/)\n\n## 其他專案\n\n* [Django Ninja Shortener - 類 Bitly 短網址服務](https://github.com/twtrubiks/django-ninja-shortener)\n\n* [SyncDocs - 即時協作文件編輯器](https://github.com/twtrubiks/sync-docs)\n\n## 執行環境\n\n* Python 3.12\n\n* VSCode\n\n## Reference\n\n* [Django Ninja - Fast Django REST Framework](https://django-ninja.dev/)\n\n* [Django Ninja Extra](https://eadwincode.github.io/django-ninja-extra/)\n\n* [Ninja JWT](https://eadwincode.github.io/django-ninja-jwt/)\n\n## Donation\n\n文章都是我自己研究內化後原創，如果有幫助到您，也想鼓勵我的話，歡迎請我喝一杯咖啡 :laughing:\n\n綠界科技ECPAY ( 不需註冊會員 )\n\n![alt tag](https://payment.ecpay.com.tw/Upload/QRCode/201906/QRCode_672351b8-5ab3-42dd-9c7c-c24c3e6a10a0.png)\n\n[贊助者付款](http://bit.ly/2F7Jrha)\n\n歐付寶 ( 需註冊會員 )\n\n![alt tag](https://i.imgur.com/LRct9xa.png)\n\n[贊助者付款](https://payment.opay.tw/Broadcaster/Donate/9E47FDEF85ABE383A0F5FC6A218606F8)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftwtrubiks%2Fdjango_ninja_tutorial","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftwtrubiks%2Fdjango_ninja_tutorial","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftwtrubiks%2Fdjango_ninja_tutorial/lists"}