Feature/faq

README.md

@@ -56,4 +56,4 @@ make setup
 # uv remove --dev <package name>
 # or uv add --group dev <package name>
 > uv remove --dev pre-commit
-```
+```

src/config/settings.py

@@ -27,21 +27,51 @@
 
 ALLOWED_HOSTS = []
 
+# 외부 라이브러리 (Third-party Apps)
+THIRD_PARTY_APPS = [
+    "rest_framework",
+    "drf_spectacular",
+]
 
-# Application definition
+# 로컬 애플리케이션 (Local Apps)
+LOCAL_APPS = [
+    "config",
+    "faq",
+]
 
-INSTALLED_APPS = [
-    # Built-in Django Applications
+# 기본 장고 내장 앱 (Built-in Django Applications)
+DJANGO_APPS = [
     "django.contrib.admin",
     "django.contrib.auth",
     "django.contrib.contenttypes",
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
-    # Local Applications
-    "config",
 ]
 
+#INSTALLED_APPS 구성
+INSTALLED_APPS = DJANGO_APPS + THIRD_PARTY_APPS + LOCAL_APPS
+
+# rest_framework settings
+REST_FRAMEWORK = {
+    'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
+    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
+    'PAGE_SIZE': 10,
+    'MAX_PAGE_SIZE': 100,
+    'PAGE_SIZE_QUERY_PARAM': 'page_size',
+}
+# spectacular settings
+SPECTACULAR_SETTINGS = {
+    'TITLE': 'HelloPy Backend API',
+    'DEFAULT_SCHEMA_CLASS': 'HelloPy API Documentation',
+    'VERSION': '0.1.0',
+    # API 스키마 파일 직접 제공 여부
+    'SERVE_INCLUDE_SCHEMA': False,
+    'SWAGGER_UI_SETTINGS' : {
+        'persisAuthorization': True,
+    },
+}
+
 MIDDLEWARE = [
     "django.middleware.security.SecurityMiddleware",
     "django.contrib.sessions.middleware.SessionMiddleware",

src/config/urls.py

@@ -15,8 +15,19 @@
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
 from django.contrib import admin
-from django.urls import path
+from django.conf import settings
+from django.urls import include, path
 
 urlpatterns = [
     path('admin/', admin.site.urls),
+    path('api/faqs/', include('faq.urls')), # 앱의 urls.py를 포함
 ]
+
+# 개발 환경에서만 Swagger 및 Redoc 활성화
+if settings.DEBUG:
+    from drf_spectacular.views import SpectacularAPIView, SpectacularRedocView, SpectacularSwaggerView
+    urlpatterns += [
+        path('api/schema/', SpectacularAPIView.as_view(), name='schema'),
+        path('api/docs/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),
+        path('api/redoc/', SpectacularRedocView.as_view(url_name='schema'), name='redoc'),
+    ]

src/faq/admin.py

@@ -0,0 +1,2 @@
+
+# Register your models here.

src/faq/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class FaqConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "faq"

src/faq/migrations/0001_initial.py

@@ -0,0 +1,72 @@
+# Generated by Django 5.1.5 on 2025-02-05 01:16
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="FAQ",
+            fields=[
+                ("id", models.AutoField(primary_key=True, serialize=False)),
+                (
+                    "status",
+                    models.CharField(
+                        choices=[
+                            ("normal", "게시됨"),
+                            ("hidden", "숨김"),
+                            ("deleted", "삭제됨"),
+                        ],
+                        default="normal",
+                        max_length=10,
+                        verbose_name="게시물 상태",
+                    ),
+                ),
+                ("question", models.CharField(max_length=255, verbose_name="질문")),
+                ("answer", models.TextField(verbose_name="답변")),
+                (
+                    "question_type",
+                    models.CharField(
+                        choices=[("activity", "활동"), ("conference", "기타등등")],
+                        max_length=20,
+                    ),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+            ],
+            options={
+                "verbose_name": "FAQ",
+                "verbose_name_plural": "FAQs",
+            },
+        ),
+        migrations.CreateModel(
+            name="Notice",
+            fields=[
+                ("id", models.AutoField(primary_key=True, serialize=False)),
+                (
+                    "status",
+                    models.CharField(
+                        choices=[
+                            ("normal", "게시됨"),
+                            ("hidden", "숨김"),
+                            ("deleted", "삭제됨"),
+                        ],
+                        default="normal",
+                        max_length=10,
+                        verbose_name="게시물 상태",
+                    ),
+                ),
+                ("title", models.CharField(max_length=255, verbose_name="공지 제목")),
+                ("content", models.TextField(verbose_name="공지 내용")),
+            ],
+            options={
+                "verbose_name": "공지사항",
+                "verbose_name_plural": "공지사항 목록",
+            },
+        ),
+    ]

src/faq/migrations/0002_delete_notice_remove_faq_question_type_and_more.py

@@ -0,0 +1,36 @@
+# Generated by Django 5.1.5 on 2025-02-06 16:05
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("faq", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.DeleteModel(
+            name="Notice",
+        ),
+        migrations.RemoveField(
+            model_name="faq",
+            name="question_type",
+        ),
+        migrations.RemoveField(
+            model_name="faq",
+            name="status",
+        ),
+        migrations.AddField(
+            model_name="faq",
+            name="is_deleted",
+            field=models.BooleanField(default=False, verbose_name="삭제 여부"),
+        ),
+        migrations.AlterField(
+            model_name="faq",
+            name="id",
+            field=models.BigAutoField(
+                auto_created=True, primary_key=True, serialize=False, verbose_name="ID"
+            ),
+        ),
+    ]

src/faq/migrations/0003_notice_alter_faq_id.py

@@ -0,0 +1,32 @@
+# Generated by Django 5.1.5 on 2025-02-07 05:44
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("faq", "0002_delete_notice_remove_faq_question_type_and_more"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Notice",
+            fields=[
+                ("id", models.AutoField(primary_key=True, serialize=False)),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                ("title", models.CharField(max_length=255, verbose_name="공지 제목")),
+                ("content", models.TextField(verbose_name="공지 내용")),
+            ],
+            options={
+                "verbose_name": "공지사항",
+                "verbose_name_plural": "공지사항 목록",
+            },
+        ),
+        migrations.AlterField(
+            model_name="faq",
+            name="id",
+            field=models.AutoField(primary_key=True, serialize=False),
+        ),
+    ]

src/faq/migrations/0004_delete_notice_alter_faq_id.py

@@ -0,0 +1,23 @@
+# Generated by Django 5.1.5 on 2025-02-09 11:05
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("faq", "0003_notice_alter_faq_id"),
+    ]
+
+    operations = [
+        migrations.DeleteModel(
+            name="Notice",
+        ),
+        migrations.AlterField(
+            model_name="faq",
+            name="id",
+            field=models.BigAutoField(
+                auto_created=True, primary_key=True, serialize=False, verbose_name="ID"
+            ),
+        ),
+    ]

src/faq/models.py

@@ -0,0 +1,16 @@
+from django.db import models
+
+class FAQ(models.Model):
+    """
+    ### FAQ 필드 정의
+    """
+    is_deleted = models.BooleanField(default=False, verbose_name="삭제 여부")
+    question = models.CharField(max_length=255, verbose_name="질문")
+    answer = models.TextField(verbose_name="답변")
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+    class Meta:
+        verbose_name = "FAQ"
+        verbose_name_plural = "FAQs"
+    def __str__(self):
+        return self.question

src/faq/serializers.py

@@ -0,0 +1,10 @@
+from rest_framework import serializers
+
+from .models import FAQ
+
+
+class FAQSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = FAQ
+        fields = ['id', 'question', 'answer', 'is_deleted', 'created_at', 'updated_at']
+

src/faq/tests.py

@@ -0,0 +1,2 @@
+
+# Create your tests here.

src/faq/urls.py

@@ -0,0 +1,7 @@
+from rest_framework.routers import DefaultRouter
+from .views import FAQViewSet
+
+router = DefaultRouter()
+router.register(r'', FAQViewSet, basename="faq")  # 'faqs' 대신 빈 문자열
+
+urlpatterns = router.urls