sw-docs v1.0.4

sw-cli

安装

npm install -g sw-docs

使用

sw-docs -h

• u, --url

  • 获取 swagger.json 的 URL
  • 指定 Swagger API 规范的 URL。这个选项是必需的。

• p, --proxy

  • proxy 前缀
  • 指定 API 请求的前缀。默认为 /api。如果您的 API 请求需要一个前缀，可以使用此选项进行设置。例如：--proxy /api。

• o, --output

  • api 生成路径
  • 指定生成的 TypeScript 接口文件的路径。默认为 ./API。您可以设置为希望存放生成文件的目录。例如：--output ./src/api。

• r, --reserve

  • swagger 自动生成的模板是否保留
  • 指定是否保留 Swagger 自动生成的模板文件。默认为 false。如果为 true，模板文件将在生成后保留；如果为 false，则会被删除。例如：--reserve true。

• t, --templateDir

  • 使用指定的 swagger 模板目录
  • 指定自定义 Swagger 模板的目录。如果您有自定义模板需要使用，请提供模板路径。例如：--templateDir ./my-template。

目录结构

• controller 生成控制器文件
• modules 生成类型文件