Zbanx-proto2api 文档

描述

• 快速生成services类型、接口文件

脚手架使用文档

$ npm install -g @zbanx/proto2api

$ cd proto2api

$ zbanx-proto2api -d ./xxx.proto

命令行说明

Usage: proto2api [options]

Convert proto file to api file

Options:
Options:
  -V, --version             output the version number
  --debug                   开发模式下使用，使用 ts-node 运行src下面的文件
  -d, --dir <string>        proto目录或者文件，如果是目录会进行文件扫描，此目录下面所有文件会进行编译
  -o, --output <string>     输出路径(default: "./")
  --reqeustName <type>      request name (default: "request")
  --reqeustPath <type>      request path (default: "umi")
  --apiPrefix <string>      api prefix path (default: "")
  --moitApiPrefix <string>  omit api prefix path (default: "")
  -h, --help                display help for command

项目开发

pnpm install

项目发布

$ make publish