HiAPI Cloud 知识库

全团队唯一的公共文档仓库。所有参与 HiAPI Cloud 开发的人(及其 AI 助手)都应有本仓库的读权限,并将其 clone 到自己项目仓库的同级目录。

获取访问权限

仓库地址:https://codeup.aliyun.com/5fc3a87ce89148238ce820ce/hiapi-cloud/hiapi-docs.git

没有读权限的话找仓库管理员在 Codeup 「成员」里加你(默认只读 Reporter 即可,需要提 PR 改文档的给 Developer)。

三条路径,按需进入

你是谁	从哪开始
🆕 新加入的开发者	onboarding/architecture — 架构总图 → 术语表 → 环境搭建 → 第一个任务
💻 日常写代码	conventions/backend — 后端/前端/API 设计规范,写代码前必读
🔌 要调别人的接口	api/ — 接口文档在 EOLINK,这里教你怎么看、怎么用 AI 查

目录结构

onboarding/    新人入职:架构总图、术语表、环境搭建、上手路径
conventions/   开发规范:后端套路、前端规范、API 设计约定
modules/       模块地图:每个仓库/服务是干什么的、Owner 是谁
domains/       跨模块专题:授权保护、支付、消息中心、微前端…(索引页)
decisions/     ADR 架构决策记录:为什么这么设计(只增不改)
contracts/     跨团队接口契约草案(契约先行流程)
api/           接口文档指南:EOLINK 使用方式 + AI(MCP)配置 + 同步流水线

待办

跨会话的后续工作见 TODO.md(其余服务的接口文档补全、同步 skill、已知问题等)。

维护规矩(三条)

1. 改了行为就改文档:你的代码改动影响了架构/接口/规范,同一时间更新对应文档(本仓库或你项目内的 docs/),PR 里一起看。
2. 每个模块有 Owner:见 modules/index.md,文档过期先找 Owner。
3. 快照不留:「XX 完成总结」「XX 实施进展」这类一次性文档不进本仓库;要么写成描述最终态的文档,要么留在 PR 描述里。

给 AI 助手(Claude Code 等)的说明

• 本仓库是全局规范与架构的唯一来源,各项目仓库的 CLAUDE.md 会指向这里。
• 接口详情不在本仓库,通过 EOLINK MCP 查询,配置见 api/index.md。

本地预览文档站点

pnpm install
pnpm docs:dev     # 本地预览
pnpm docs:build   # 构建静态站点(部署到内网 nginx)