dangerous1990/protoc-plugins

protoc-gen-swagger

• what's this?
• why?
• how to use
  • 1. 首先如果没有安装过protoc需要安装protoc
  • 2. clone当前项目
  • 3. 执行init.sh
  • 4. sample

what's this?

基于bilibili kratos的protoc-gen-bswagger修改而来，通过proto文件生成restful的swagger.json文档

why?

对于生成的swagger.json有一些定制内容

how to use

1. 首先如果没有安装过protoc需要安装protoc

https://github.com/protocolbuffers/protobuf

2. clone当前项目

git clone https://github.com/dangerous1990/protoc-plugins.git

3. 执行init.sh

进入protoc-plugins项目执行

./init.sh

4. sample

• hello.proto

syntax = "proto3";
import "google/api/annotations.proto";

service HelloWorld {
    // hello
    rpc Hello (HelloReq) returns (HelloReply) {
        option (google.api.http) = {
            post:"/hello"
        };
    };
}
message HelloReq{
}
message HelloReply{
    string name =1;
}

• 使用protoc生成swagger.json

protoc -I"${GOPATH}/src/proto" -Iexample example/hello.proto  --swagger_out=example

protoc-plugins's Issues

validate:"required"是不是无效

message Minority{ // 少数民族信息名称 string Name =3 [(gogoproto.jsontag) = 'name',(gogoproto.moretags)='gorm:"column:CH_NAME",validate:"required"']; // 所属组织REF int64 orgRef =4 [(gogoproto.jsontag) = 'orgRef',(gogoproto.moretags)='gorm:"column:I_ORG_REF",validate:"required"']; }
validate:"required"没有正确生成
"properties": { "id": { "type": "integer", "description": "唯一标识" }, "name": { "type": "string", "description": "少数民族信息名称" }, "orgRef": { "type": "integer", "description": "所属组织REF" }, "orgName": { "type": "string", "description": "所属组织名称" }, "nationNumber": { "type": "integer", "description": "少数民族成分数量" } }