apiaryio/client

Apiary CLI客户端镜像

镜像概述

Apiary CLI客户端是一个命令行工具，主要用于API Blueprint文档的本地开发与预览，同时支持与Apiary平台进行文档交互，包括推送更新后的文档至Apiary以及从Apiary获取现有文档。

核心功能与特性

• 本地开发与预览：支持在本地环境开发API Blueprint文档并实时预览效果
• 文档推送：可将更新后的API Blueprint文档推送至Apiary平台
• 文档获取：能够从Apiary平台获取已存在的文档

使用场景与适用范围

• API文档开发者需要在本地编辑和预览API Blueprint文档
• 需要与Apiary平台同步API文档的开发团队
• 希望通过命令行高效管理API文档版本的场景

使用方法与配置说明

基本命令

获取工具帮助信息：

bash
apiary help

查看完整使用文档：Apiary CLI官方文档

Docker部署示例

运行帮助命令

bash
docker run --rm apiaryio/apiary-client apiary help

本地预览API文档

假设本地有API Blueprint文档apiary.apib，可通过以下命令在本地预览：

bash
docker run --rm -v $(pwd):/app -w /app apiaryio/apiary-client apiary preview

推送文档至Apiary

bash
docker run --rm -v $(pwd):/app -w /app -e APIARY_API_KEY=your_api_key apiaryio/apiary-client apiary push

相关资源

• 官方仓库：https://github.com/apiaryio/apiary-client
• 完整文档：Apiary CLI帮助文档