📝 docs: Add documentation

This commit is contained in:
web@ppanel
2025-12-11 03:29:07 +00:00
parent 50e695a1bb
commit 99e7f6062d
135 changed files with 79115 additions and 8 deletions
+13
View File
@@ -0,0 +1,13 @@
---
title: 管理端服务 API
outline: false
aside: false
---
# 管理端服务
涵盖后台仪表盘、运维管理、商务管理、用户支持、日志分析等核心接口。
<ClientOnly>
<ScalarIframe spec-url="https://raw.githubusercontent.com/perfect-panel/ppanel-docs/refs/heads/main/public/swagger/admin.json" title="管理端服务" />
</ClientOnly>
+13
View File
@@ -0,0 +1,13 @@
---
title: 通用服务 API
outline: false
aside: false
---
# 通用服务
提供认证、工具等可复用接口,供用户端与管理端共同调用。Schema 直接来源于 GitHub 仓库,确保与后端版本保持一致。
<ClientOnly>
<ScalarIframe spec-url="https://raw.githubusercontent.com/perfect-panel/ppanel-docs/refs/heads/main/public/swagger/common.json" title="通用服务" />
</ClientOnly>
+13
View File
@@ -0,0 +1,13 @@
---
title: 网关 API
outline: false
aside: false
---
# 网关
网关接口围绕服务注册、版本发现、心跳和更新编排展开,节点通过共享的 `service_name`/`secret` 认证方式汇报状态并获取控制面的滚动指令。
<ClientOnly>
<ScalarIframe spec-url="https://raw.githubusercontent.com/perfect-panel/ppanel-docs/refs/heads/main/public/swagger/gateway.json" title="网关" />
</ClientOnly>
+16
View File
@@ -0,0 +1,16 @@
---
title: API 文档
outline: false
aside: false
---
# API 文档
本页通过 Scalar(以 iframe 嵌入方式)渲染存放在 [`public/swagger`](https://github.com/perfect-panel/ppanel-docs/tree/main/public/swagger) 目录下的 OpenAPI 文件。每个 JSON Schema 都有独立页面,方便在侧边栏快速切换:
- [通用服务](./common) — 认证、工具等可复用接口。
- [用户服务](./user) — 用户门户、订阅、订单、工单等接口。
- [管理端服务](./admin) — 仪表盘、运维、商务、日志等后台接口。
- [网关](./gateway) — 提供版本检查、心跳、注册与更新编排等节点生命周期接口。
请在左侧选择具体服务进入交互式 API 文档。
+13
View File
@@ -0,0 +1,13 @@
---
title: 用户服务 API
outline: false
aside: false
---
# 用户服务
覆盖订阅、订单、钱包、工单、资料等用户门户相关接口。
<ClientOnly>
<ScalarIframe spec-url="https://raw.githubusercontent.com/perfect-panel/ppanel-docs/refs/heads/main/public/swagger/user.json" title="用户服务" />
</ClientOnly>