KAN-177 Create Django + Ninja example (#35)

django/README.md

@@ -0,0 +1,10 @@
+# 개요
+* django 예제
+
+# 목차
+* [django helloword](./helloworld/)
+* [ninja + django](./ninjaExample/)
+
+# 같이 보면 좋은 자료
+* [파이썬 패키지 관리 도구 - poetry](https://malwareanalysis.tistory.com/734)
+* [pycharm 에서 django 실행 방법](https://malwareanalysis.tistory.com/736)

django/helloworld/README.md

@@ -13,3 +13,6 @@ $ poetry install
 $ cd djangoExample
 $ python manager.py runserver
 ```
+
+# 다음 예제
+* [ninja + django](../ninjaExample/)

django/ninjaExample/ninjaExample/README.md

@@ -0,0 +1,25 @@
+# 개요
+* django + ninja API framework 예제
+
+# 설치방법
+
+```sh
+$ pip install poetry
+$ poetry shell
+$ poetry install
+$ python manage.py runserver
+```
+
+# API 목록
+
+> swagger 문서 참고: http://127.0.0.1:8000/api/docs
+
+* [http://127.0.0.1:8000/api/ping](./ping/api.py)
+* [http://127.0.0.1:8000/api/ping/hello](./ping/api.py)
+
+# 이 예제에서 알게 된 것
+
+* ninja framework는 FastAPI처럼 api 객체를 리턴한다.
+* 따라서, api객체를 다루는 것이 ninja framework의 핵심이다.
+* FastAPI와 같이 중첩(Nested) router를 지원한다. 이 예제에서는 중첩 router를 사용했다.
+* 다음 예제는 uvicorn 연동을 할 예정!

django/ninjaExample/ninjaExample/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "ninjaExample.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()

django/ninjaExample/ninjaExample/ninjaExample/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for ninjaExample project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.0/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "ninjaExample.settings")
+
+application = get_asgi_application()

django/ninjaExample/ninjaExample/ninjaExample/settings.py

@@ -0,0 +1,123 @@
+"""
+Django settings for ninjaExample project.
+
+Generated by 'django-admin startproject' using Django 5.0.6.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.0/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/5.0/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/5.0/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "django-insecure-xb$#p0(%3efo&7kds8_v@oe0-e_6j29%a%j1oz3a(h6ft22pri"
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+]
+
+ROOT_URLCONF = "ninjaExample.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = "ninjaExample.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/5.0/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/5.0/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/5.0/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = "UTC"
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/5.0/howto/static-files/
+
+STATIC_URL = "static/"
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/5.0/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

django/ninjaExample/ninjaExample/ninjaExample/urls.py

@@ -0,0 +1,38 @@
+# """
+# URL configuration for ninjaExample project.
+#
+# The `urlpatterns` list routes URLs to views. For more information please see:
+#     https://docs.djangoproject.com/en/5.0/topics/http/urls/
+# Examples:
+# Function views
+#     1. Add an import:  from my_app import views
+#     2. Add a URL to urlpatterns:  path('', views.home, name='home')
+# Class-based views
+#     1. Add an import:  from other_app.views import Home
+#     2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+# Including another URLconf
+#     1. Import the include() function: from django.urls import include, path
+#     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+# """
+#
+# from django.contrib import admin
+# from django.urls import include, path
+#
+# urlpatterns = [
+#     path("ping/", include("ping.urls")),
+#     # path("admin/", admin.site.urls),
+# ]
+
+from django.contrib import admin
+from django.urls import path
+from ninja import NinjaAPI
+from ping.api import router as ping_router
+
+api = NinjaAPI()
+api.add_router("ping", ping_router)
+
+
+urlpatterns = [
+    # path("admin/", admin.site.urls),
+    path("api/", api.urls)
+]

django/ninjaExample/ninjaExample/ninjaExample/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for ninjaExample project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.0/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "ninjaExample.settings")
+
+application = get_wsgi_application()

django/ninjaExample/ninjaExample/ping/api.py

@@ -0,0 +1,11 @@
+from ninja import Router
+
+router = Router()
+
+@router.get('/')
+def ping(request):
+    return {'ping': 'pong'}
+
+@router.get('/hello')
+def ping(request):
+    return {'ping': 'pong'}