- 一个 yapi 客户端，为了方便将本地编写的 markdown 文档解析上传到公司/组织的 yapi 文档管理中心
- 换句话说，将本地 markdown 文档保存到 yapi 服务上。
- PHP 7.2+
- 目前只支持 macOS、Linux 系统
- 公司的文档服务器可能不是很靠谱，有可能丢失数据。你可以建立一个 git 仓库存放你的 markdown 文档。而 markdown 文档又可以直接通过
yc命令提交到你公司的文档服务中。相当于多一个备份。 - yapi 后台编辑文档繁琐、效率不够高，如果直接在本地编辑 markdown 文档，然后通过命令行更新到 yapi 后台，此时效率大大提升。
git clone https://github.com/suhanyujie/php-yapi-client.gitcd php-yapi-clientcomposer install
cp env.example .env- 根据需要，在
.env文件中修改 yapi 服务的地址以及文档 project 对应的 token
- 打包成 phar
./build.php cp yc.phar /usr/local/bin/yc
- 1.按照要求写文档
- 要使用该 yapi 客户端，需要必须按照合法的要求写 markdown，格式参考此模板。
- 2.使用
yc命令提交文档。例如：yc /path/businessName/loginDoc.md。- 当然如果需要提交当前路径下的
loginDoc.md文件，可以执行yc loginDoc.md
- 当然如果需要提交当前路径下的
- 1.参数个数为 2 个时，表示直接提交某个md文档到 yapi 上，如
yc /some/path/a.md，token 从环境变量总获取 YC_TOKEN - 2.参数个数为 3 个时，如
yc file /some/path/a.md同第一种功能 - 3.参数个数为 3 个时，如
yc dir /some/path表示使用环境变量中的 token 提交 path 目录下的所有 md 文档 - 4.参数个数为 4 个时，如
yc file someTokenFlag /some/path/a.md表示使用 someTokenFlag 对应的 token 提交该md文档 - 5.参数个数为 4 个时，如
yc dir someTokenFlag /some/path表示使用 someTokenFlag 对应的 token 提交目录/some/path下的md文档
- 更新文档到组织的 yapi 服务中
- 上传时，在配置的多个 token 中选一个项目的token
- 支持上传目录下的所有 md 文档
- 命令行列出配置的 token flag
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent