protoc-gen-go-gin

README

protoc-gen-go-gin

修改自 nfsq246 修改自 mohuishou 修改自 kratos v2

从 protobuf 文件中生成使用 gin 的 http rpc 服务

安装

请确保安装了以下依赖:

• go 1.16
• protoc
• protoc-gen-go

注意由于使用 embed 特性，Go 版本必须大于 1.16

go install gitee.com/kevin2027/protoc-gen-go-gin@latest

使用说明

例子见: example

proto 文件约定

默认情况下 rpc method 命名为 方法+资源，使用驼峰方式命名，生成代码时会进行映射

方法映射方式如下所示:

• "GET", "FIND", "QUERY", "LIST", "SEARCH" --> GET
• "POST", "CREATE" --> POST
• "PUT", "UPDATE" --> PUT
• "DELETE" --> DELETE

service BlogService {
  rpc CreateArticle(Article) returns (Article) {}
  // 生成 http 路由为 post: /article
}

除此之外还可以使用 google.api.http option 指定路由，可以通过添加 additional_bindings 使一个 rpc 方法对应多个路由

// blog service is a blog demo
service BlogService {
  rpc GetArticles(GetArticlesReq) returns (GetArticlesResp) {
    // 
    // 可以通过添加 additional_bindings 使一个 rpc 方法对应多个路由
    option (google.api.http) = {
      get: "/v1/articles"
      additional_bindings {
        get: "/v1/author/{author_id}/articles"
      }
    };
  }
}

文件生成

  protoc -I ./example/api \
  --go_out ./example/api --go_opt=paths=source_relative \
  --go-gin_out ./example/api --go-gin_opt=paths=source_relative \
  example/api/product/app/v1/v1.proto

相关介绍

待发布

• Go工程化(四) API 设计上: 项目结构 & 设计
• Go工程化(五) API 设计下: 基于 protobuf 自动生成 gin 代码