Mina Choi
6784e59ca5
git 저장소가 없어 히스토리·협업 기반이 아예 없던 상태를 연다.
함께 문서를 재편했다. 그동안 문서가 있어도 "이 제품이 뭘 푸는가"와
"어떻게 도는가"를 담은 문서가 없어서, 목표 문장이 backend/frontend
README 두 곳에 복붙돼 있었다 — 상위 문서가 없어 아래로 샌 것이다.
신설
README.md 레포 진입점 + 문서 지도 + 문서 규칙 4가지
AGENTS.md 에이전트·신규 합류자용 함정 목록과 규약
(CLAUDE.md 는 여기로 걸린 심볼릭 링크)
docs/PRODUCT.md 제품 정의 — 문제·사용자·원칙·**non-goals**·성공 기준
docs/ARCHITECTURE.md payload 경계·발행 파이프라인·서빙 결정·앱 분리 설계
이동
backend/docs/DECISIONS.md → docs/DECISIONS.md
백엔드만의 결정이 아니다. 게다가 코드 주석 ~25곳이 이미
`docs/DECISIONS.md` 로 적고 있어 레포 루트 기준으로는 그게 맞다.
갱신
docs/DEPLOY.md 서빙 결정 반영 — nginx 정적 서빙이 지금 경로(3절),
Azure 는 나중에 켤 때(4절)로 분리
docs/ARCHITECTURE.md 사이트 = 한 장(2026-08-31) 구조 반영
docs/COLLECTION_SEO_AEO_FLOW.md
robots.txt·sitemap.xml 은 오리진 루트에만 굽는다는 점 명시
frontend/site/scripts/prerender.ts
헤더 주석의 렌더 보고서 경로가 실제(422줄)와 달라 수정
.gitignore
★ CLAUDE.md 를 더 이상 무시하지 않는다. 에이전트 지침은 팀과 모든
에이전트가 공유하는 규약이라 커밋해야 한다 — 무시하면 클론한 사람이
"배포 후 republish_all.py 필수" 같은 함정을 전달받지 못한다.
개인용 오버라이드는 ~/.claude/CLAUDE.md 에 둔다.
87 lines
2.8 KiB
Python
87 lines
2.8 KiB
Python
import json
|
|
from typing import Optional
|
|
|
|
from fastapi import Query
|
|
from pydantic import BaseModel, Field
|
|
|
|
from common.enums import ErrorType, UserRole
|
|
|
|
|
|
class StructModel:
|
|
"""프로토콜/구조체 식별용 마커 클래스."""
|
|
|
|
pass
|
|
|
|
|
|
class ErrorInfo(BaseModel, StructModel):
|
|
"""모든 응답에 공통으로 실리는 결과 정보. result.success / code / desc 로 내려간다."""
|
|
|
|
success: Optional[bool] = True
|
|
code: Optional[int] = ErrorType.SUCCESS.value
|
|
desc: Optional[str] = ErrorType.SUCCESS.name
|
|
|
|
def SetResult(self, enum: ErrorType):
|
|
if enum is not None:
|
|
self.success = ErrorType.SUCCESS.value == enum.value
|
|
self.code = enum.value
|
|
self.desc = enum.name
|
|
|
|
|
|
# ---- Protocol 규약 -------------------------------------------------------
|
|
# 모든 통신 패킷은 WebPacketProtocol 을 상속한다.
|
|
# 요청 : Req_xxx (WebPacketProtocol)
|
|
# 응답 : Res_xxx (Res_WebPacketProtocol) - 항상 result 필드를 가진다.
|
|
# 각 라우터 폴더의 protocol.py 에 Req_/Res_ 를 정의한다.
|
|
class WebPacketProtocol(BaseModel, StructModel):
|
|
pass
|
|
|
|
|
|
class Req_WebPacketProtocol(WebPacketProtocol):
|
|
pass
|
|
|
|
|
|
class Res_WebPacketProtocol(WebPacketProtocol):
|
|
# default_factory 로 인스턴스마다 새 ErrorInfo 를 생성한다 (mutable default 공유 방지).
|
|
result: ErrorInfo = Field(default_factory=ErrorInfo)
|
|
msg: Optional[str] = None
|
|
|
|
|
|
class Res_PageProtocol(Res_WebPacketProtocol):
|
|
# 목록 응답 공용 페이지 메타.
|
|
total: int = 0
|
|
page: int = 0
|
|
size: int = 0
|
|
|
|
|
|
class PageParams:
|
|
# 목록 엔드포인트 공용 쿼리 파라미터. 라우터에서 Depends() 로 주입한다.
|
|
def __init__(self, page: int = Query(1, ge=1), size: int = Query(20, ge=1, le=100)):
|
|
self.page = page
|
|
self.size = size
|
|
|
|
@property
|
|
def skip(self) -> int:
|
|
return (self.page - 1) * self.size
|
|
|
|
|
|
class UserInfo(StructModel):
|
|
"""JWT subject 로 인코딩되는 유저 식별 정보."""
|
|
|
|
user_id: str # users.user_id (uuid) — 데이터 스코프 키
|
|
id: str # users.id (로그인 아이디) — get_me 재조회 키
|
|
company_id: str # users.company_id (uuid) — 멀티테넌트 스코프 키
|
|
role: int # users.role (UserRole) — 권한 게이트(최고관리자 등) 판단 키
|
|
|
|
def __init__(self, *args, **kwargs) -> None:
|
|
super().__init__()
|
|
# 구버전 토큰(role 미포함) 도 디코딩되도록 기본값을 먼저 깔고 kwargs 로 덮어쓴다.
|
|
self.role = UserRole.USER.value
|
|
for dictionary in args:
|
|
for key in dictionary:
|
|
setattr(self, key, dictionary[key])
|
|
for key in kwargs:
|
|
setattr(self, key, kwargs[key])
|
|
|
|
def to_json(self) -> str:
|
|
return json.dumps(self.__dict__)
|