protoc-gen-apidoc

README

protoc-gen-apidoc

根据 Proto 文件生成接口文档。支持 Swagger、Postman、HTML、Markdown 等多种格式输出。

---

安装

• protoc
• protoc--gen-go

  go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
  
  # protoc-gen-go-grpc
  go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
  

• protoc--gen-gogo

  go install github.com/gogo/protobuf/protoc-gen-gogo@latest
  

• protoc-gen-apidoc

  # 方式一
  go install github.com/charlesbases/protoc-gen-apidoc@latest
  
  # 方式二
  git clone https://github.com/charlesbases/protoc-gen-apidoc.git
  cd protoc-gen-apidoc && go install .
  

• google/protobuf/*.proto

  git clone https://github.com/charlesbases/protobuf.git
  cp -r protobuf/google ${GOPATH}/src/.
  # 或
  cd protobuf && make init
  

运行

• 运行参数
  • host: 接口地址
  • port: 接口端口

    host、port 不指定时，swagger 会自动适配当前 swagger 文档的路径
    

  • title: 服务名称

    不指定时，默认使用 pb 文件所在的 package name
    

  • header: 请求头
  • output: 输出格式。支持 swagger、postman、html、markdown. (default: swagger)
  • scheme: http or https

    scheme 不指定时，swagger 会自动适配当前 swagger 文档的 scheme
    

# default
protoc -I=${GOPATH}/src:. --gogo_out=paths=source_relative:. --apidoc_out=header=Authorization:swagger/static pb/*.proto

protoc -I=${GOPATH}/src:. --gogo_out=paths=source_relative:. \
  --apidoc_out=host=0.0.0.0,port=8080,title=User,header=Authorization,output=swagger,output=postman:swagger/static \
  pb/*.proto

proto 文件注释格式

• 格式一: 默认请求方式为 POST

  syntax = "proto3";
  
  option go_package = ".;pb";
  
  package pb;
  
  import "pb/base.proto";
  
  // 用户服务
  service Users {
    // 用户列表
    rpc List (Request) returns (Response) {}
  }
  
  // 入参
  message Request {
    // 用户id
    int64 id = 1;
    // 用户名
    string name = 2;
  }
  
  // 出参
  message Response {
    // 用户id
    int64 id = 1;
    // 用户名
    string name = 2;
  }
  

• 格式二: 自定义请求方式、请求路径、Content-Type

  syntax = "proto3";
  
  option go_package = ".;pb";
  
  package pb;
  
  import "pb/base.proto";
  import "google/protobuf/plugin/http.proto";
  
  // 用户服务
  service Users {
    // 获取用户
    rpc User (Request) returns (Response) {
      option (google.protobuf.plugin.http) = {
        get: "/api/v1/users/{uid}"
      };
    }
    // 用户列表
    rpc UserList (Request) returns (Response) {
      option (google.protobuf.plugin.http) = {
        get: "/api/v1/users"
      };
    }
    // 创建用户
    rpc UserCreate (Request) returns (Response) {
      option (google.protobuf.plugin.http) = {
        post: "/api/v1/users"
      };
    }
    // 更新用户
    rpc UserUpdate (Request) returns (Response) {
      option (google.protobuf.plugin.http) = {
        put: "/api/v1/users/{uid}"
      };
    }
    // 删除用户
    rpc UserDelete (Request) returns (Response) {
      option (google.protobuf.plugin.http) = {
        delete: "/api/v1/users/{uid}"
      };
    }
    // 用户头像上传
    rpc UserUpload (Upload) returns (Response) {
      option (google.protobuf.plugin.http) = {
        put: "/api/v1/users/{uid}"
        consume: "multipart/form-data"
      };
    }
    // 用户头像下载
    rpc UserUpload (Request) returns (Upload) {
      option (google.protobuf.plugin.http) = {
        get: "/api/v1/users/{uid}"
        produce: "multipart/form-data"
      };
    }
  }
  
  // 入参
  message Request {
    // 用户id
    int64 id = 1;
    // 用户名
    string name = 2;
  }
  
  // 出参
  message Response {
    // 用户id
    int64 id = 1;
    // 用户名
    string name = 2;
  }
  
  // 头像上传
  message Upload {
   FileType type = 1;
   bytes file = 2;
  }
  
  // 图片类型
  enum FileType {
    JPG = 0;
    PNG = 1;
    GIF = 2;
  }
  

附录

• Swagger-UI