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 에 둔다.
168 lines
7.9 KiB
Python
168 lines
7.9 KiB
Python
from uuid import UUID
|
|
|
|
from fastapi import APIRouter, Depends, Query
|
|
|
|
from common.models.gmodel import UserInfo
|
|
from router.v1.validator.dependencies import IsValidAccessToken, RemoveNoneResponse
|
|
from services.site_service import SiteService
|
|
from .protocol import (
|
|
Req_SiteSlug,
|
|
Req_SiteStatus,
|
|
Req_SiteTemplate,
|
|
Req_SiteTheme,
|
|
Req_StartBuild,
|
|
Res_PublishLogs,
|
|
Res_Site,
|
|
Res_SeoAudit,
|
|
Res_SiteSlug,
|
|
Res_SiteVersions,
|
|
Res_SlugCheck,
|
|
Res_StartBuild,
|
|
)
|
|
|
|
# 사이트/발행 라우터. 사업장 하위 리소스이며 회사 스코프는 service 가 사업장 조회로 강제한다.
|
|
router = APIRouter(prefix="/v1/place/{place_id}/site", tags=["Site"], responses={404: {"description": "Not found"}})
|
|
|
|
|
|
@router.get(
|
|
path="",
|
|
response_model=Res_Site,
|
|
summary="사이트 상태",
|
|
description="현재 발행 버전과 재빌드 필요 여부(needs_rebuild). "
|
|
"노출값이 바뀐 뒤 다시 빌드하지 않았으면 true — 이 사업장만 재빌드하면 된다.",
|
|
)
|
|
async def get_site(place_id: UUID, service: SiteService = Depends(), user_info: UserInfo = Depends(IsValidAccessToken)):
|
|
return RemoveNoneResponse(await service.get_site(user_info, str(place_id)))
|
|
|
|
|
|
@router.get(
|
|
path="/audit",
|
|
response_model=Res_SeoAudit,
|
|
summary="SEO/AEO 준비도 진단",
|
|
description="현재 확인된 콘텐츠와 최신 빌드를 SEO·AEO 각각 100점으로 채점하고 개선 항목을 반환한다. "
|
|
"준비도 점수이며 실제 검색 순위나 AI 인용을 보장하지 않는다.",
|
|
)
|
|
async def get_seo_audit(
|
|
place_id: UUID, service: SiteService = Depends(), user_info: UserInfo = Depends(IsValidAccessToken)
|
|
):
|
|
return RemoveNoneResponse(await service.get_seo_audit(user_info, str(place_id)))
|
|
|
|
|
|
@router.get(
|
|
path="/slug/check",
|
|
response_model=Res_SlugCheck,
|
|
summary="사이트 주소 사용 가능 확인",
|
|
description="쓰고 싶은 주소를 미리 본다. 소문자 영문·숫자·하이픈 3~50자만 되고, 예약어와 남이 쓰는 주소는 막힌다. "
|
|
"★ 서버가 상호명으로 자동 확정하지 않는다 — 사람이 고른다. "
|
|
"못 쓰면 reason(INVALID_LENGTH·INVALID_FORMAT·RESERVED·TAKEN)과 대안 하나(suggestion)를 준다. "
|
|
"지금 자기가 쓰는 주소면 available=true 다.",
|
|
)
|
|
async def check_slug(
|
|
place_id: UUID,
|
|
service: SiteService = Depends(),
|
|
user_info: UserInfo = Depends(IsValidAccessToken),
|
|
slug: str = Query(..., description="쓰고 싶은 주소(예: doflo)"),
|
|
):
|
|
return RemoveNoneResponse(await service.check_slug(user_info, str(place_id), slug))
|
|
|
|
|
|
@router.post(
|
|
path="/slug",
|
|
response_model=Res_SiteSlug,
|
|
summary="사이트 주소 확정",
|
|
description="주소를 sites.domain 에 저장한다(사이트 행이 없으면 만든다). "
|
|
"검증은 check 와 같은 규칙으로 서버가 다시 한다 — 클라이언트 검증을 믿지 않는다. "
|
|
"★ 이미 발행된 사이트의 주소는 바꿀 수 없다(SITE_SLUG_LOCKED) — "
|
|
"색인된 주소가 바뀌면 AI 검색이 잡아 둔 페이지가 404 가 된다.",
|
|
)
|
|
async def set_slug(
|
|
place_id: UUID, req: Req_SiteSlug, service: SiteService = Depends(), user_info: UserInfo = Depends(IsValidAccessToken)
|
|
):
|
|
return RemoveNoneResponse(await service.set_slug(user_info, str(place_id), req))
|
|
|
|
|
|
@router.post(
|
|
path="/template",
|
|
response_model=Res_Site,
|
|
summary="템플릿(디자인) 선택 저장",
|
|
description="위저드에서 고른 템플릿을 sites.template_id 에 저장한다(사이트 행이 없으면 만든다). "
|
|
"★ 서버는 값을 검증하지 않는다 — 템플릿 목록은 프론트가 소유한다. 길이(100자)만 막는다. "
|
|
"★ 주소와 달리 발행 뒤에도 바꿀 수 있다: 디자인이 바뀌어도 URL 은 그대로라 색인이 깨지지 않는다. "
|
|
"이미 발행된 사이트면 재빌드가 필요하다는 표시로 content_updated_at 을 찍는다(needs_rebuild=true).",
|
|
)
|
|
async def set_template(
|
|
place_id: UUID,
|
|
req: Req_SiteTemplate,
|
|
service: SiteService = Depends(),
|
|
user_info: UserInfo = Depends(IsValidAccessToken),
|
|
):
|
|
return RemoveNoneResponse(await service.set_template(user_info, str(place_id), req))
|
|
|
|
|
|
@router.post(
|
|
path="/theme",
|
|
response_model=Res_Site,
|
|
summary="디자인(색·서체·섹션) 저장",
|
|
description="에디터가 정한 색·서체·섹션(순서·on/off·배리에이션)을 sites.theme 에 저장한다"
|
|
"(사이트 행이 없으면 만든다). body 최상위 키는 theme 하나다: "
|
|
"{\"theme\":{\"colors\":{...},\"fontStyle\":\"...\",\"colorPaletteId\":\"...\","
|
|
"\"sections\":[{\"id\",\"name\",\"enabled\",\"locked\",\"variantId\"}]}}. "
|
|
"★ sections 의 배열 순서가 곧 섹션 순서다(별도 order 필드 없음). "
|
|
"★ 서버는 값을 해석하지 않는다 — 섹션 목록·배리에이션 키·색 토큰은 프론트가 소유한다. "
|
|
"직렬화 크기(64KB)만 막는다. "
|
|
"★ templateId 는 여기 담지 않는다 — sites.template_id 와 POST /template 이 담당한다. "
|
|
"★ colorPaletteId 는 에디터 복원 전용이라 저장·반환만 하고 발행 payload 에는 싣지 않는다. "
|
|
"★ 빈 값({})을 보내면 NULL 로 되돌아가 업종 기본 색·서체·섹션으로 떨어진다. "
|
|
"★ 템플릿과 같이 발행 뒤에도 바꿀 수 있다(디자인이 바뀌어도 URL 은 그대로다). "
|
|
"이미 발행된 사이트면 재빌드가 필요하다는 표시로 content_updated_at 을 찍는다"
|
|
"(needs_rebuild=true).",
|
|
)
|
|
async def set_theme(
|
|
place_id: UUID,
|
|
req: Req_SiteTheme,
|
|
service: SiteService = Depends(),
|
|
user_info: UserInfo = Depends(IsValidAccessToken),
|
|
):
|
|
return RemoveNoneResponse(await service.set_theme(user_info, str(place_id), req))
|
|
|
|
|
|
@router.post(
|
|
path="/build",
|
|
response_model=Res_StartBuild,
|
|
summary="정적 빌드(비동기)",
|
|
description="스냅샷을 박제해 HTML + JSON-LD 를 만들고 발행 검수 게이트를 돌린다. "
|
|
"publish=true 면 통과 시 바로 발행한다. ★ 게이트를 우회하는 옵션은 없다.",
|
|
)
|
|
async def start_build(
|
|
place_id: UUID, req: Req_StartBuild, service: SiteService = Depends(), user_info: UserInfo = Depends(IsValidAccessToken)
|
|
):
|
|
return RemoveNoneResponse(await service.start_build(user_info, str(place_id), req))
|
|
|
|
|
|
@router.get(path="/version/list", response_model=Res_SiteVersions, summary="빌드 버전 목록")
|
|
async def list_versions(place_id: UUID, service: SiteService = Depends(), user_info: UserInfo = Depends(IsValidAccessToken)):
|
|
return RemoveNoneResponse(await service.list_versions(user_info, str(place_id)))
|
|
|
|
|
|
@router.get(
|
|
path="/log/list",
|
|
response_model=Res_PublishLogs,
|
|
summary="발행 기록",
|
|
description="발행 시도와 거부 사유. 게이트가 막았으면 무엇이 문제였는지 detail 에 남는다.",
|
|
)
|
|
async def list_logs(place_id: UUID, service: SiteService = Depends(), user_info: UserInfo = Depends(IsValidAccessToken)):
|
|
return RemoveNoneResponse(await service.list_logs(user_info, str(place_id)))
|
|
|
|
|
|
@router.post(
|
|
path="/status",
|
|
response_model=Res_Site,
|
|
summary="발행 상태 전이(중지·재개·내림)",
|
|
description="★ 해지는 삭제가 아니라 상태 전이다. 색인된 페이지를 갑자기 404 로 만들면 "
|
|
"AI 검색이 그 자리를 다시 OTA 로 채운다.",
|
|
)
|
|
async def change_status(
|
|
place_id: UUID, req: Req_SiteStatus, service: SiteService = Depends(), user_info: UserInfo = Depends(IsValidAccessToken)
|
|
):
|
|
return RemoveNoneResponse(await service.change_status(user_info, str(place_id), req))
|