npm i
安装依赖后,执行 npm run dev
,执行成功后本地访问 http://127.0.0.1:16001/api_design 查看 API 设计页面
![image](https://private-user-images.githubusercontent.com/36812439/287239408-5b6c5dc0-54ee-4838-8978-5f7d4a9699c2.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjQ1NTU4MDUsIm5iZiI6MTcyNDU1NTUwNSwicGF0aCI6Ii8zNjgxMjQzOS8yODcyMzk0MDgtNWI2YzVkYzAtNTRlZS00ODM4LTg5NzgtNWY3ZDRhOTY5OWMyLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA4MjUlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwODI1VDAzMTE0NVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTE1YTkxMzExZGY2ZmFlYzhkMmJiYjQ5MmVmYmI2ZDA1ODNlNjI4NmE2MGE0MWVkZjBhMjRlNDhmZGQzZTY3YTYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.tnswwMmR27mZ6hssd_aVeS4277NFC2TFPkKaHywz0i0)
你可以主界面里做组件 API 的增删改查操作。
![image](https://private-user-images.githubusercontent.com/36812439/287239723-a6de19e7-a68a-4012-8ab1-d0d809dc75d0.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjQ1NTU4MDUsIm5iZiI6MTcyNDU1NTUwNSwicGF0aCI6Ii8zNjgxMjQzOS8yODcyMzk3MjMtYTZkZTE5ZTctYTY4YS00MDEyLThhYjEtZDBkODA5ZGM3NWQwLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA4MjUlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwODI1VDAzMTE0NVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWFkNmE2NWYyYzk2N2QyOWNjMzU2OTQwMDkwODYyNWE5ZjAzZjZiNWY2MjVkNGY2YzFhOGE3ZjFkMjJmNWQxMDkmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.sm1b-UWUozbYzmkW1wXqpK7F3yIqvq-w-UPAIrxXLJk)
点击 “Generate API Files” 按钮,指定生成组件和技术栈框架平台,确认后会在本地 packages/products/
对应仓库目录下生成对应 md 文档、API 定义等文件。
本地生成了相关文件,修改 db 中的数据后,需要将所有修改都以 PR 方式提交到仓库中,找其他同学 review,PR 合并后 GitHub Action 会自动根据本次提交的内容,使用 @github-actions github-actions[bot] 的账号自动向对应 TDesign 组件仓库创建分支,并提交本次修改的代码。
你可以自行发起 PR,也可以让开发者在对应分支上继续实现。
例:https://github.com/TDesignOteam/tdesign-react-test/pull/6
拉取某技术栈仓库 Button 组件的 API 定义文件: 组件仓库放在同级目录 然后执行脚本 如 npm run api:docs Button 'Vue(PC)' finalProject
更多指令见 命令行操作