windows中go环境配置protoc-gen-swagger
时间: 2024-11-24 09:43:15 浏览: 12
protoc-gen-go与protoc-gen-go-grpc插件
在Windows系统上配置Go语言环境并安装`protoc-gen-swagger`插件,主要是为了支持将Google的Protocol Buffers (protobuf)协议转换为Swagger规范的API文档。以下是基本步骤:
1. **安装Go语言**:
- 如果还没有安装Go,首先访问 https://golang.org/dl 下载适合Windows的最新版本,然后按照提示安装。
2. **安装Protobuf**:
- Go语言环境中通常包含protoc编译器,但如果需要特定版本,可以下载官方的 Protobuf for Windows: https://github.com/protocolbuffers/protobuf/releases
- 解压后,将`bin`文件夹添加到系统的PATH环境变量中,以便在命令行中直接运行protoc。
3. **全局安装protoc-gen-swagger**:
- 使用Go的包管理工具 `go get` 安装插件:
```
go get github.com/goswagger/goswagger/cmd/protoc-gen-swagger
```
这将下载并安装protoc-gen-swagger插件。
4. **验证安装**:
- 在命令行输入以下命令检查protoc-gen-swagger是否可用:
```
protoc --version
protoc-gen-swagger version
```
如果一切正常,你会看到protoc-gen-swagger的版本信息。
5. **配置Swagger文件生成**:
- 当你需要生成Swagger文档时,可以在.proto文件中使用`option (grpc_swagger)`注解指定生成文件的位置,例如:
```proto
syntax = "proto3";
option (grpc_swagger) = { api_version: "2.0", info: { title: "Your API Title", ... } };
service YourService {
rpc YourMethod (.YourMessage) returns (.YourResponse) {
option (grpc_swagger) = { swagger_tag: "yourTag" };
}
}
```
然后运行 `protoc` 与相应的参数生成Swagger JSON文件。
阅读全文