README.md

free-swagger-cli

free-swagger-cli 基于 free-swagger，提供命令行交互功能，全量生成 api 并写入至项目文件

快速上手

npx(推荐)

npx free-swagger-cli

npm

npm i free-swagger-cli -g

free-swagger-cli

之后需要输入 swagger 源，可以是 url，也可以是本地的 json 文件的路径

详细配置

输出 ts 文件或者编辑模版等高级功能，需要详细配置

npx free-swagger-cli --config

在运行一次后 free-swagger-cli 会记住用户上一次的配置项

默认模版

free-swagger 基于内置了默认模版函数，用于生成 api 代码片段，详细参数见 free-swagger-core

生成 mock 文件

除了生成 api，free-swagger-cli 还可以生成 mock 文件

npx free-swagger-cli --mock

和详细配置 free-swagger-cli 步骤相似，输入一个 swagger 源，全量生成 mock 数据（json），配合其他 mock 工具实现本地 mock

额外生成了一个 mock.js 文件用于汇总所有 json，这使得 mock 工具只需引入一个 mock.js 即可实现本地 mock

注意：free-swagger-cli 只输出 mock 文件，不提供本地 mock 服务

所有命令

• --config/-c 以配置项启动 free-swagger-cli

npx free-swagger-cli --config

• --mock/-m 全量生成 mock 文件

npx free-swagger-cli --mock

• --reset/-r 重置为默认配置

npx free-swagger-cli --reset

• --show/-s 显示当前配置

npx free-swagger-cli --show

• --edit/-e 编辑当前配置

npx free-swagger-cli --edit

• --help/-h output usage information

npx free-swagger-cli --help

常见问题

swagger 文档不规范，请检查参数格式

当前 swagger 源可能需要鉴权，free-swagger 提供了 cookie 选项，填入有权限的 cookie

或者直接将 swagger 源下载到本地，输入文件路径

某些接口的 mock 文件没有生成

不规范的 swagger 文档可能会导致部分 mock 数据丢失，free-swagger 会作出警告