feat(web): 分类展示公开 API 文档并修复 DEV 启动 #27

Merged
easyai merged 3 commits from codex/improve-api-docs-categories into main 2026-07-22 17:23:47 +08:00
Owner

变更原因

公开 API 文档需要区分通用开放接口与厂商兼容接口;本地 DEV 启动脚本同时错误假定 easyai-pgvector 容器必然存在。

主要变更

  • 新增完整公开 API 目录,按通用开放接口、Gemini、可灵、火山和 server-main 兼容接口分类
  • 增加分类路由、搜索、接入约定与回归测试
  • 保留显式 AI_GATEWAY_DATABASE_URL,不再被容器探测覆盖
  • 自动识别当前 Compose postgres 服务及宿主机映射端口
  • 找不到匹配容器时跳过不适用的 Docker 建库,并为独立建库命令返回明确错误

影响与风险

  • 不修改 HTTP 接口、请求或响应契约,无需重新生成 OpenAPI
  • 主要风险为文档目录遗漏及不同本地数据库拓扑兼容性,已由目录计数测试、构建和真实 DEV 启动覆盖

验证

  • go vet ./...
  • go test ./...
  • govulncheck ./...:代码调用链 0 个漏洞
  • pnpm install --frozen-lockfile
  • pnpm lint
  • pnpm test:Web 108 项通过,API 全部通过
  • pnpm build
  • pnpm audit --audit-level high:仅 1 个 low
  • docker compose -f docker-compose.yml config --quiet
  • tests/release/manual-release-test.sh
  • tests/ci/migrations-test.sh
  • bash -n 与 ShellCheck
  • pnpm dev 真实启动 API 8088 与 Web 5178
## 变更原因 公开 API 文档需要区分通用开放接口与厂商兼容接口;本地 DEV 启动脚本同时错误假定 easyai-pgvector 容器必然存在。 ## 主要变更 - 新增完整公开 API 目录,按通用开放接口、Gemini、可灵、火山和 server-main 兼容接口分类 - 增加分类路由、搜索、接入约定与回归测试 - 保留显式 AI_GATEWAY_DATABASE_URL,不再被容器探测覆盖 - 自动识别当前 Compose postgres 服务及宿主机映射端口 - 找不到匹配容器时跳过不适用的 Docker 建库,并为独立建库命令返回明确错误 ## 影响与风险 - 不修改 HTTP 接口、请求或响应契约,无需重新生成 OpenAPI - 主要风险为文档目录遗漏及不同本地数据库拓扑兼容性,已由目录计数测试、构建和真实 DEV 启动覆盖 ## 验证 - go vet ./... - go test ./... - govulncheck ./...:代码调用链 0 个漏洞 - pnpm install --frozen-lockfile - pnpm lint - pnpm test:Web 108 项通过,API 全部通过 - pnpm build - pnpm audit --audit-level high:仅 1 个 low - docker compose -f docker-compose.yml config --quiet - tests/release/manual-release-test.sh - tests/ci/migrations-test.sh - bash -n 与 ShellCheck - pnpm dev 真实启动 API 8088 与 Web 5178
easyai added 2 commits 2026-07-22 17:17:00 +08:00
将通用开放接口与兼容接口分层展示,补充完整接口目录、分类路由、搜索能力和接入约定。\n\n验证:pnpm nx run web:test;pnpm nx run web:build
保留显式数据库连接配置,自动识别 Compose PostgreSQL 容器及宿主机端口,并在容器不存在时跳过不适用的 Docker 建库。\n\n验证:bash -n;ShellCheck;scripts/create-database.sh;pnpm dev 真实启动 API 与 Web
easyai added 1 commit 2026-07-22 17:23:25 +08:00
补充本地验证证据要求,明确经用户授权可合并 PR 或直接更新 main,并禁止等待或伪造已经取消的 CI 状态。\n\n同时继续隔离 Git 变更授权与 publish、deploy 两阶段生产授权。\n\n验证:tests/release/manual-release-test.sh
easyai merged commit e3f6c0fa3e into main 2026-07-22 17:23:47 +08:00
Sign in to join this conversation.
No Reviewers
No labels
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: BCAI/easyai-ai-gateway#27