Feature/swagger

.gitignore

@@ -169,3 +169,9 @@ cython_debug/
 
 # PyPI configuration file
 .pypirc
+
+# UV
+.python-version
+
+# vscode settings
+.vscode/

README.md

@@ -1,2 +1,202 @@
 # hellopy-backend
+
 hellopy-backend
+
+## 빠른 시작 가이드
+
+```bash
+# 개발 환경 설정
+make setup
+
+# DB 마이그레이션
+make migration
+
+# runserver (default port: 8080, host: 0.0.0.0)
+make run
+
+# runserver specific port
+make run PORT=9999
+
+# runserver localhost only
+make run HOST=localhost
+
+# run test
+make test
+```
+
+## 개발 환경 설정 가이드
+
+```text
+make setup
+```
+
+### 패키지 매니저 사용법
+
+#### 글로벌 디펜던시 설정
+
+```bash
+# 패키지 설치하기
+# uv add <package name>
+> uv add django
+
+# 패키지 삭제하기
+# uv remove <package name>
+> uv remove django
+```
+
+#### 개발 디펜던시 설정
+
+```bash
+# 패키지 설치하기
+# uv add --dev <package name>
+# or uv add --group dev <package name>
+> uv add --dev pre-commit
+
+# 패키지 삭제하기
+# uv remove --dev <package name>
+# or uv add --group dev <package name>
+> uv remove --dev pre-commit
+```
+
+## API 사용 예시 (아직 TAG는 적용 X)
+
+()의 경우 '()'자체는 생략  
+해당 내용에 맞게 변경해야하는 부분
+ex) (id) -> 1
+
+### (POST) FAQ 생성
+```bash
+{"status":"SUCCESS","error":null,"data":{"id":2,"question":"API란 무엇인가요?","answer":"API는 애플리케이션 간의 통신을 위한 인터페이스입니다.","is_deleted":false,"created_at":"2025-02-06T16:14:12.381235Z","updated_at":"2025-02-06T16:14:12.381272Z"}}
+```
+```bash
+curl -X POST http://localhost:8080/api/faqs/ \
+     -H "Content-Type: application/json" \
+     -d '{
+         "question": "API란 무엇인가요?",
+         "answer": "API는 애플리케이션 간의 통신을 위한 인터페이스입니다.",
+         "question_type": "activity",
+         "status": "normal"
+     }'
+```
+
+```javascript
+fetch("http://localhost:8080/api/faqs/", {
+    method: "POST",
+    headers: { "Content-Type": "application/json" },
+    body: JSON.stringify({
+        question: "API란 무엇인가요?",
+        answer: "API는 애플리케이션 간의 통신을 위한 인터페이스입니다.",
+        question_type: "activity",
+        status: "normal"
+    })
+})
+.then(response => response.json())
+.then(data => console.log(data))
+.catch(error => console.error("Error:", error));
+```
+
+### (GET) FAQ 조회
+```bash
+curl -X GET http://localhost:8080/api/faqs/
+```
+
+```javascript
+fetch("http://localhost:8080/api/faqs/")
+  .then(response => response.json())
+  .then(data => console.log(data))
+  .catch(error => console.error("Error:", error));
+```
+
+### (GET) 특정 FAQ 조회
+- 리스트 조회
+```bash
+curl -X GET http://localhost:8080/api/faqs/(id)/
+```
+
+```javascript
+fetch("http://localhost:8080/api/faqs/2/")
+  .then(response => response.json())
+  .then(data => console.log(data))
+  .catch(error => console.error("Error:", error));
+```
+
+- 페이지네이션
+```bash
+curl -X GET "http://localhost:8080/api/faqs/?page=1"
+```
+
+```javascript
+fetch("http://localhost:8080/api/faqs/?page=1&page_size=10", {
+    method: "GET",
+    headers: {
+        "Accept": "application/json",
+        "Content-Type": "application/json"
+    }
+})
+.then(response => response.json())
+.then(data => {
+    console.log("FAQ 목록:", data.data);
+    console.log("페이지네이션 정보:", data.pagination);
+})
+.catch(error => console.error("Error fetching FAQs:", error));
+```
+
+### (PUT) FAQ 수정
+```bash
+curl -X PUT http://localhost:8080/api/faqs/(id)/ \
+     -H "Content-Type: application/json" \
+     -d '{
+         "question": "REST API란 무엇인가요?",
+         "answer": "REST API는 HTTP를 통해 데이터를 전송하는 API입니다.",
+         "question_type": "activity",
+         "status": "normal"
+     }'
+```
+
+```javascript
+fetch("http://localhost:8080/api/faqs/(id)/", {
+    method: "PUT",
+    headers: { "Content-Type": "application/json" },
+    body: JSON.stringify({
+        question: "REST API란 무엇인가요?",
+        answer: "REST API는 HTTP를 통해 데이터를 전송하는 API입니다."
+    })
+})
+.then(response => response.json())
+.then(data => console.log(data))
+.catch(error => console.error("Error:", error));
+```
+
+### (PATCH) FAQ 부분 수정
+```bash
+curl -X PATCH http://localhost:8080/api/faqs/(id)/ \
+     -H "Content-Type: application/json" \
+     -d '{
+         "answer": "REST API는 클라이언트와 서버 간의 통신을 돕는 인터페이스입니다."
+     }'
+```
+
+```javascript
+fetch("http://localhost:8080/api/faqs/2/", {
+    method: "PATCH",
+    headers: { "Content-Type": "application/json" },
+    body: JSON.stringify({ answer: "REST API는 클라이언트와 서버 간의 통신을 돕는 인터페이스입니다." })
+})
+.then(response => response.json())
+.then(data => console.log(data))
+.catch(error => console.error("Error:", error));
+```
+
+### (DELETE) FAQ 삭제
+```bash
+curl -X DELETE http://localhost:8080/api/faqs/(id)/
+```
+
+```javascript
+fetch("http://localhost:8080/api/faqs/2/", {
+    method: "DELETE"
+})
+.then(response => response.json())
+.then(data => console.log(data))
+.catch(error => console.error("Error:", error));
+```

makefile

@@ -0,0 +1,27 @@
+PORT=8080
+HOST=0.0.0.0
+
+setup:
+	uv sync
+	uv run src/manage.py makemigrations
+
+migration:
+	uv run src/manage.py migrate
+
+run:
+	uv run src/manage.py runserver $(HOST):$(PORT)
+
+unit-test:
+	uv run src/manage.py test --tag=unit
+
+feature-test:
+	uv run src/manage.py test --tag=feature
+
+e2e-test:
+	uv run src/manage.py test --tag=e2e
+
+test:
+	uv run src/manage.py test
+
+export-swagger:
+	uv run src/manage.py spectacular --file swagger/api.yaml

pyproject.toml

@@ -2,26 +2,42 @@
 name = "hellopy-backend"
 version = "0.1.0"
 description = "hellopy-backend"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = ["django>=5.1.5", "djangorestframework>=3.15.2", "rich>=13.9.4"]
 
 [tool.ruff]
 target-version = "py312"
 extend-exclude = [
-   "**/*.yaml", "**/.gitignore", "**/.ruff_cache/*", "**/.mypy_cache.*", 
-   "**/assets/*", "**/.vscode/*", "**/.git/*", "**/.idea/*"
+   "**/*.yaml",
+   "**/.gitignore",
+   "**/.ruff_cache/*",
+   "**/.mypy_cache.*",
+   "**/__pycache__/*",
+   "**/assets/*",
+   "**/.vscode/*",
+   "**/.git/*",
+   "**/.idea/*",
+   "**/temp/*",
+   "**/*venv*/*",
 ]
 line-length = 100
+fix = true
 indent-width = 4
 
-[tool.ruff.lint] 
+[tool.ruff.lint]
 select = ["I", "E4", "E7", "E9", "F"]
 ignore = []
 fixable = ["ALL"]
-unfixable= []
+unfixable = []
 
 [tool.ruff.format]
 quote-style = "double"
 indent-style = "space"
-skip-magic-trailing-comma= false
+skip-magic-trailing-comma = false
 line-ending = "auto"
-docstring-code-format= false
-docstring-code-line-length = "dynamic"
+docstring-code-format = false
+docstring-code-line-length = "dynamic"
+
+[dependency-groups]
+dev = ["drf-spectacular>=0.28.0", "pre-commit>=4.1.0", "ruff>=0.9.4"]

src/config/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for config 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.1/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings')
+
+application = get_asgi_application()