Skip to content

后端完整文档 ​

后端文档统一维护在本目录。server_api/sql/ 保留核心和插件数据库脚本;数据库结构、引用关系等说明文档仍归文档站管理。

OpenAPI 源文件位于 public/openapi/admin_openapi.yaml、public/openapi/api_openapi.yaml,接口页面生成脚本直接读取这些文件。

插件安装归档 ​

安装和升级会将发行包的 docs/ 归档到 plugin/archives/{plugin_id}/{version}/,包含接口、数据库引用和更新说明。

  • 默认 Wiki 根目录为 server_api 同级的 go_basic_frame_wiki,与执行命令时的工作目录无关。
  • 安装、升级、移除与 Purge 支持 --wiki-root /path/to/go_basic_frame_wiki;使用自定义位置时,各命令须传同一路径。
  • 发行包仍使用 docs/api、docs/database、docs/updates,无需修改已有包或历史迁移摘要。
  • Remove 保留文档归档;Purge 从 Wiki 检查最新版本数据库引用说明,成功后清理对应插件归档。
  • 升级旧宿主前,将原 server_api/plugin_docs/ 整体迁至 go_basic_frame_wiki/plugin/archives/,保留目录层级与历史内容;缺少数据库引用说明时 Purge 继续拒绝执行。
  • 仅运行 API 服务无需文档站。执行插件安装或清理的机器需要可读写 Wiki 根目录;容器内使用时须挂载文档目录并传入 --wiki-root。
sh
cd server_api
go run . plugin install package.zip --wiki-root ../go_basic_frame_wiki --apply-database
go run . plugin upgrade package.zip --wiki-root ../go_basic_frame_wiki --apply-database

历史插件归档保存交付时的原文,历史路径描述不作为当前操作指南。