TDesign API 维护工具

本地启动

npm i 安装依赖后，执行 npm run dev，执行成功后本地访问 http://127.0.0.1:16001/api_design 查看 API 设计页面

功能说明

主功能界面

你可以主界面里做组件 API 的增删改查操作。

生成 API

点击 “Generate API Files” 按钮，指定生成组件和技术栈框架平台，确认后会在本地 packages/products/ 对应仓库目录下生成对应 md 文档、API 定义等文件。

提交

本地生成了相关文件，修改 db 中的数据后，需要将所有修改都以 PR 方式提交到仓库中，找其他同学 review，PR 合并后 GitHub Action 会自动根据本次提交的内容，使用 @github-actions github-actions[bot] 的账号自动向对应 TDesign 组件仓库创建分支，并提交本次修改的代码。

例：#12

你可以自行发起 PR，也可以让开发者在对应分支上继续实现。

例：https://github.com/TDesignOteam/tdesign-react-test/pull/6

命令行操作

拉取某技术栈仓库 Button 组件的 API 定义文件： 组件仓库放在同级目录 然后执行脚本 如 npm run api:docs Button 'Vue(PC)' finalProject

更多指令见 命令行操作