README_zh.md

apidoc

English | 简体中文

这是一个使用 swagger2.0 定义，基于模板文件生成API静态文档（如pdf）的命令行工具和 Golang工具包。

安装

1、源码

前提条件

wkhtmltopdf 必须被安装。

• MacOS: brew install Caskroom/cask/wkhtmltopdf
• 其它操作系统安装方式见 https://wkhtmltopdf.org/downloads.html.

安装命令

go install github.com/zc2638/apidoc/cmd/apidoc@latest

2、Docker

docker pull zc2638/apidoc:latest

使用 Docker

docker run --rm zc2638/apidoc:latest --src https://petstore.swagger.io/v2/swagger.json --data > petstore.pdf

使用命令行工具

文件

apidoc --src <your-swagger-json> [--dest <your-output-dir>]

根据URL

apidoc --src https://petstore.swagger.io/v2/swagger.json

工具包使用示例

请查看 example