用于把proto文件转换成特定语言的api文件
fork 修改记录
- 修复 protoDir 问题,现象:proto 文件中的 import 再 -d 加入转换后认为是不同的文件,导致 duplicate 错误
- 默认请求地址,根据 service 和 method 名称生成
使用说明
- 先把需要转换的proto文件确定好
- 依次遍历proto文件,然后转换成ts文件
快速开始
npm install -g proto2api
cd proto2api
proto2api -d examples/hello.proto -o api
命令行说明
Usage: proto2api [options]
Convert proto file to api file
Options:
Options:
-V, --version output the version number
--debug load code with ts-node for debug
-d, --dir <type> directory address of Protocol Buffers. eq: /path/pbdir
or /path/hello.proto
-o, --output <type> Output api path
--protoDir <type> The root directory for loading proto files. By default,
the directory folder named proto3|proto2 will be found.
If it still does not exist, it will try to find it
automatically, but the correctness is not guaranteed.
(default: "")
--apiName <type> apiName (default: "webapi")
--apiPath <type> apiPath (default: "~/utils/api")
--prefix <type> api prefix path (default: "")
--depPath <type> the address of the external dependency proto library.
eq: /common/proto3 (default: "")
--ignore [ignore...] ignore unnecessary generated pb files (default:
"google|swagger")
-h, --help display help for command
-h, --help display help for command
参考文档
Google Protobuf 语法指南 https://developers.google.com/protocol-buffers/docs/proto3