api html
1.0.0
将任何 API 规范转换为出色的 HTML 文档网站
API HTML
npm i api-html -g
api-html --url https://petstore.swagger.io/v2/swagger.json
演示
上面的命令会将给定的url转换为当前目录中名为dist目录的静态网站。
还可以传递file而不是url 。
| 参数 | 短的 | 必需的 | 默认值 | 细节 |
|---|---|---|---|---|
--file | -f | required | 无效的 | 本地源文件的路径，同时需要--file或--url on。 |
--url | -u | required | 无效的 | 在线源文件的 URL，同时需要--file或--url on。 |
--type | -t | 选修的 | swagger | API 规范的编码类型，例如swagger 、 openapi 、 api_blueprint 、 io_docs 、 google 、 raml或wadl |
--version | -v | 选修的 | 2 | OpenAPI ( swagger ) 的版本，可能的值为 1、2 或 3。仅适用于swagger |
--yaml | -y | 选修的 | 0 | 如果源文件类型为yaml则该值应为1 ，仅适用于swagger |
--option | -o | 选修的 | ./options.json | 选项文件的路径，请参阅下面的详细信息 |
api-html --yaml 1 --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v2.0/yaml/api-with-examples.yaml
# A Swagger (OpenAPI) version 2 source file with yaml type
api-html --version 3 --url https://api.gettyimages.com/swagger/v3/swagger.json
# A Swagger (OpenAPI) version 3 source file with json type
api-html --version 3 --yaml 1 --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml
# A Swagger (OpenAPI) version 3 source file with yaml type
api-html --type api_blueprint --url https://raw.githubusercontent.com/apiaryio/api-blueprint/master/examples/Polls%20API.md
# An API Blueprint source file
api-html --type google --url https://www.googleapis.com/discovery/v1/apis/translate/v2/rest
# A Google API descory source file
api-html --type raml --url https://raw.githubusercontent.com/raml-apis/XKCD/master/api.raml
# A RAML source file
api-html --type io_docs --url https://raw.githubusercontent.com/lucybot/api-spec-converter/master/test/input/io_docs/foursquare.json
# An IO Docs source file
选项应该位于 json 文件中，如果不传递--option参数，那么我们将检查名称为options.json的当前目录。
| 姓名 | 默认值 | 描述 |
|---|---|---|
theme | compact | 设置UI主题，值为：“compact”和“basic”。 |
baseColor | #6e9a04 | 设置主题的基色 |
textColor | #FFF | 设置主题的文字颜色 |
logo | '招摇标志' | 将徽标指向本地文件 |
logoUrl | ” | 将徽标指向 URL |
isCoding | true | 显示或隐藏请求中的编码部分 |
isSearch | true | 显示或隐藏搜索功能 |
isTryRequest | true | 显示或隐藏请求中的“试用”按钮 |
isBackToTopButton | true | 隐藏或显示BackToTop按钮 |
isCreditLink | true | 隐藏或显示导航栏下方的Credit链接 |
pageTitle | swagger.json文件中的title | 设置浏览器标题栏上显示的页面标题。 |
customHeadScript | ” | 将自定义脚本添加到 head 标签 |
customFootScript | ” | 将自定义脚本添加到 foot 标签 |
pageTags | ” | 代表页面的元关键词，每个关键词之间用逗号分隔。元关键词对页面搜索引擎优化很有帮助。 |
pageDescription | ” | 表示页面的元描述 |
apiVersions | ” | API 版本，按以下格式输入： （名称）[网址] （名称）[网址] ... 经验： (V1)[https://zamacall.io/docs/v1/] (V2)[https://zamacall.io/docs/v2/] |
headerMenuItems | ” | 标题菜单项，按以下格式输入： （名称）[网址] （名称）[网址] ... 经验： （主网站）[https://zamacall.io] (联系我们)[https://zamacall.io/contact/] |
{
"logo": "logo.svg",
"baseColor": "blue"
}
IO Docs源文件的支持WADL源文件的支持RAML源文件的支持Google API Descory源文件的支持API Blueprint源文件的支持YAML源文件的支持OpenAPI (swagger) 版本 1、2 和 3 的支持。cURL 、 Node 、 Python和JavaScriptGithub 问题
