https://github.com/mohuishou/protoc-gen-go-gin

从 protobuf 文件中生成使用 gin 的 http rpc 服务 (protobuf to gin code)
https://github.com/mohuishou/protoc-gen-go-gin

gin go golang protoc

Last synced: 2 months ago
JSON representation

从 protobuf 文件中生成使用 gin 的 http rpc 服务 (protobuf to gin code)

• Host: GitHub
• URL: https://github.com/mohuishou/protoc-gen-go-gin
• Owner: mohuishou
• Created: 2021-02-24T02:55:19.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-08-24T02:06:14.000Z (over 2 years ago)
• Last Synced: 2024-09-30T07:21:33.252Z (3 months ago)
• Topics: gin, go, golang, protoc
• Language: Go
• Homepage:
• Size: 50.8 KB
• Stars: 111
• Watchers: 1
• Forks: 44
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# protoc-gen-go-gin

> 修改自 [kratos v2](https://github.com/go-kratos/kratos/tree/main/cmd/protoc-gen-go-http)

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

## 安装

请确保安装了以下依赖:

- [go 1.16](https://golang.org/dl/)

- [protoc](https://github.com/protocolbuffers/protobuf)

- [protoc-gen-go](https://github.com/protocolbuffers/protobuf-go)

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

```bash

go install github.com/mohuishou/protoc-gen-go-gin@latest

```

## 使用说明

例子见: [example](./example)

### proto 文件约定

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

方法映射方式如下所示:

- `"GET", "FIND", "QUERY", "LIST", "SEARCH"`  --> GET

- `"POST", "CREATE"`  --> POST

- `"PUT", "UPDATE"`  --> PUT

- `"DELETE"`  --> DELETE

```protobuf

service BlogService {

  rpc CreateArticle(Article) returns (Article) {}

  // 生成 http 路由为 post: /article

}

```

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

```protobuf

// 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"

      }

    };

  }

}

```

### 文件生成

```bash

  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 代码