用于自动生成api引用的cli库
ibm-apidocs-cli的Python项目详细描述
安装
使用 pip 或 easy_install安装cli
pip install -U ibm-apidocs-cli
或
easy_install -U ibm-apidocs-cli
克隆a 云api文档 回购到本地目录。确保回购协议包含所需的 apiref index.json 文件和前端配置文件 (通常 <;openapi>;-config.json )。
配置github访问令牌。你可以跳过这一步 不希望cli自动下载最新的前端内容 和sdk生成器代码。
遵循以下步骤:
从[github]获取访问令牌 企业](https://github.ibm.com/settings/tokens" rel="nofollow">https://github.ibm.com/settings/tokens。为了更多 有关信息,请参阅github 帮助
设置github令牌环境变量:
export GITHUB_TOKEN=<token>
< > >
- 可选: 克隆frontmatter 发电机 到本地目录。如果您没有 前端物质生成器repo,cli将自动将其克隆到 临时目录。
- 可选: 安装sdk 发电机 到本地目录。如果您没有sdk的本地副本 生成器,cli将自动将最新版本下载到 一个临时目录。
要安装sdk生成器,不需要克隆或下载 完全存储库或生成项目。相反,使用 安装程序 。 有关更多信息,请参见生成器 自述
注意: sdk generator.jar文件必须命名为 openapi sdkgen.jar 。如果您已下载或生成 文件名不同(例如,``openapi sdkgen-<;version>;.jar``),您可以 必须重命名。