oxipage-core 0.2.0

Oxipage 코어 라이브러리 — Axum 서버 부트스트랩, SQLite 마이그레이션, 인증, Extension trait, SSR 스냅샷, 레이트리밋
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

//! OpenAPI 스펙 (doc/04 §4.5).
//!
//! **편차:** `utoipa` 자동 생성 대신 수동 `serde_json` 스펙. 의존성 절약 + 코어
//! 라우트를 즉시 문서화. 확장 라우트는 차후 `Extension::openapi_paths()` 훅으로
//! 병합(별도 작업). `/api/console/docs/openapi.json` + `/api/console/docs`(Swagger UI CDN).

use serde_json::{json, Value};

pub fn openapi_spec(base_url: &str) -> Value {
    let server = if base_url.is_empty() {
        "/".to_string()
    } else {
        format!("{}/", base_url.trim_end_matches('/'))
    };
    json!({
        "openapi": "3.0.3",
        "info": {
            "title": "Oxipage API",
            "version": "0.1.0",
            "description": "개인 창작 작업실 홈페이지 API (doc/04 §4.5). 공개 읽기는 인증 불필요, 쓰기는 Bearer 토큰(PAT 또는 OXIPAGE_ADMIN_TOKEN).",
            "license": { "name": "MIT" }
        },
        "servers": [{ "url": server }],
        "components": {
            "securitySchemes": {
                "bearerAuth": { "type": "http", "scheme": "bearer" }
            }
        },
        "paths": {
            "/api/console/lobby/manifest": {
                "get": {
                    "tags": ["lobby"],
                    "summary": "로비 매니페스트 (site + extensions + per-extension lobby config)",
                    "security": [],
                    "responses": ok_data("Manifest")
                }
            },
            "/api/console/lobby/config": {
                "get": {
                    "tags": ["lobby"],
                    "summary": "모든 확장의 로비 표시 설정",
                    "security": [],
                    "responses": ok_data("LobbyConfig[]")
                }
            },
            "/api/console/lobby/config/{ext_id}": {
                "put": {
                    "tags": ["lobby"],
                    "summary": "확장별 로비 표시 모드/순서 갱신 (post:write)",
                    "security": [{ "bearerAuth": [] }],
                    "parameters": [{ "name": "ext_id", "in": "path", "required": true, "schema": { "type": "string" } }],
                    "responses": ok_data("LobbyConfig")
                }
            },
            "/api/console/auth/tokens": {
                "get": {
                    "tags": ["auth"],
                    "summary": "PAT 목록 (admin 스코프)",
                    "security": [{ "bearerAuth": [] }],
                    "responses": ok_data("PatRow[]")
                },
                "post": {
                    "tags": ["auth"],
                    "summary": "새 PAT 발급 (admin 스코프). 평문은 1회만 반환.",
                    "security": [{ "bearerAuth": [] }],
                    "responses": ok_data("PatCreated")
                }
            },
            "/api/console/auth/tokens/{id}": {
                "delete": {
                    "tags": ["auth"],
                    "summary": "PAT revoke (admin 스코프)",
                    "security": [{ "bearerAuth": [] }],
                    "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }],
                    "responses": ok_data("Revoked")
                }
            },
            "/api/console/search": {
                "get": {
                    "tags": ["search"],
                    "summary": "전문 검색 (FTS5 trigram). 발행된 문서만.",
                    "security": [],
                    "parameters": [
                        { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } },
                        { "name": "lang", "in": "query", "schema": { "type": "string" } },
                        { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20 } }
                    ],
                    "responses": ok_data("SearchHit[]")
                }
            },
            "/api/console/blog/posts": {
                "get": { "tags": ["blog"], "summary": "발행본 목록 (?draft=true&lang=)", "security": [], "responses": ok_data("BlogPost[]") },
                "post": { "tags": ["blog"], "summary": "초안 생성 (post:write)", "security": [{ "bearerAuth": [] }], "responses": ok_data("BlogPost") }
            },
            "/api/console/blog/posts/{slug}/publish": {
                "post": { "tags": ["blog"], "summary": "초안 발행 (post:publish)", "security": [{ "bearerAuth": [] }], "responses": ok_data("BlogPost") }
            },
            "/api/console/projects": {
                "get": { "tags": ["projects"], "summary": "발행본 목록", "security": [], "responses": ok_data("Project[]") },
                "post": { "tags": ["projects"], "summary": "초안 생성 (post:write)", "security": [{ "bearerAuth": [] }], "responses": ok_data("Project") }
            },
            "/api/console/links": {
                "get": { "tags": ["links"], "summary": "링크 목록", "security": [], "responses": ok_data("LinkCard[]") },
                "post": { "tags": ["links"], "summary": "링크 생성 (post:write, 즉시 발행)", "security": [{ "bearerAuth": [] }], "responses": ok_data("LinkCard") }
            },
            "/api/console/novels": {
                "get": { "tags": ["novels"], "summary": "발행본 목록", "security": [], "responses": ok_data("Novel[]") },
                "post": { "tags": ["novels"], "summary": "소설 초안 생성 (post:write)", "security": [{ "bearerAuth": [] }], "responses": ok_data("Novel") }
            },
            "/api/console/movies": {
                "get": { "tags": ["movies"], "summary": "발행본 목록", "security": [], "responses": ok_data("MovieEntry[]") },
                "post": { "tags": ["movies"], "summary": "영화 리뷰 초안 (post:write)", "security": [{ "bearerAuth": [] }], "responses": ok_data("MovieEntry") }
            },
            "/api/console/books": {
                "get": { "tags": ["books"], "summary": "발행본 목록", "security": [], "responses": ok_data("Book[]") },
                "post": { "tags": ["books"], "summary": "도서 리뷰 초안 (post:write)", "security": [{ "bearerAuth": [] }], "responses": ok_data("Book") }
            },
            "/api/console/scraps": {
                "get": { "tags": ["scraps"], "summary": "발행본 스크랩 목록", "security": [], "responses": ok_data("ScrapItem[]") },
                "post": { "tags": ["scraps"], "summary": "수동 스크랩 추가 (post:write)", "security": [{ "bearerAuth": [] }], "responses": ok_data("ScrapItem") }
            },
            "/api/console/activity": {
                "get": { "tags": ["activity"], "summary": "최근 활동 목록 (읽기 전용 캐시)", "security": [], "responses": ok_data("ActivityEvent[]") }
            },
            "/api/console/activity/webhook": {
                "post": { "tags": ["activity"], "summary": "GitHub webhook 수신 (공개, 서명 검증은 Phase 4+)", "security": [], "responses": { "200": { "description": "ok" } } }
            },
            "/healthz": {
                "get": { "tags": ["system"], "summary": "헬스체크", "security": [], "responses": { "200": { "description": "ok" } } }
            }
        }
    })
}

fn ok_data(type_name: &str) -> Value {
    json!({
        "200": {
            "description": "성공",
            "content": {
                "application/json": {
                    "schema": { "type": "object", "title": type_name }
                }
            }
        }
    })
}

/// Swagger UI CDN HTML. /api/console/docs에서 서빙.
pub fn swagger_ui_html(spec_url: &str) -> String {
    const TPL: &str = r##"<!DOCTYPE html>
<html><head><meta charset="utf-8"><title>Oxipage API Docs</title>
<link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@5/swagger-ui.css">
</head><body>
<div id="swagger-ui"></div>
<script src="https://unpkg.com/swagger-ui-dist@5/swagger-ui-bundle.js"></script>
<script>
window.onload = function() {
  window.ui = SwaggerUIBundle({ url: "__SPEC_URL__", dom_id: "#swagger-ui" });
};
</script>
</body></html>"##;
    TPL.replace("__SPEC_URL__", spec_url)
}