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 에 둔다.
46 lines
1.9 KiB
Python
46 lines
1.9 KiB
Python
"""OpenAPI 스펙을 파일로 뽑는다 — 서버를 띄우지 않고.
|
|
|
|
python scripts/export_openapi.py (backend/ 에서 실행)
|
|
python scripts/export_openapi.py -o /tmp/spec.json
|
|
|
|
프론트의 API 클라이언트는 이 스펙에서 orval 이 생성한다. 서버가 떠 있으면
|
|
`npm run orval -w admin` 이 http://localhost:9800/openapi.json 을 직접 읽지만,
|
|
서버(와 DB)를 띄우기 싫을 때가 더 많다 — 그때 이 파일을 쓴다:
|
|
|
|
python scripts/export_openapi.py
|
|
cd ../frontend && ORVAL_INPUT=../../backend/openapi.json npm run orval -w admin
|
|
|
|
★ 산출물(backend/openapi.json)은 커밋하지 않는다(.gitignore). 라우터가 유일한 소스다.
|
|
"""
|
|
import argparse
|
|
import json
|
|
import os
|
|
import sys
|
|
|
|
# backend/ 를 import 경로에 올린다(scripts/ 에서 실행해도 동작하게).
|
|
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
|
|
os.environ.setdefault("APP_ENV", "local")
|
|
|
|
DEFAULT_OUT = os.path.join(os.path.dirname(os.path.dirname(os.path.abspath(__file__))), "openapi.json")
|
|
|
|
|
|
def main() -> None:
|
|
parser = argparse.ArgumentParser(description="FastAPI OpenAPI 스펙을 JSON 으로 내보낸다.")
|
|
parser.add_argument("-o", "--out", default=DEFAULT_OUT, help=f"출력 경로 (기본: {DEFAULT_OUT})")
|
|
args = parser.parse_args()
|
|
|
|
# import 시점에 app 이 만들어진다. DB 커넥션은 lifespan 에서 열리므로 여기선 DB 가 없어도 된다.
|
|
import router.router
|
|
|
|
spec = router.router.app.openapi()
|
|
with open(args.out, "w", encoding="utf-8") as f:
|
|
json.dump(spec, f, ensure_ascii=False, indent=2)
|
|
f.write("\n")
|
|
|
|
ops = sum(len([m for m in item if m in ("get", "post", "put", "patch", "delete")]) for item in spec["paths"].values())
|
|
print(f"{args.out} ({len(spec['paths'])} paths / {ops} operations)")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|