api.proto 1.0 KB

1234567891011121314151617181920212223242526272829
  1. // 定义项目 API 的 proto 文件 可以同时描述 gRPC 和 HTTP API
  2. // protobuf 文件参考:
  3. // - https://developers.google.com/protocol-buffers/
  4. // - http://info.bilibili.co/display/documentation/gRPC+Proto
  5. // protobuf 生成 HTTP 工具:
  6. // - http://git.bilibili.co/platform/go-common/tree/master/app/tool/protoc-gen-bm
  7. syntax = "proto3";
  8. import "github.com/gogo/protobuf/gogoproto/gogo.proto";
  9. import "google/protobuf/empty.proto";
  10. // package 命名使用 {discovery_id}.{version} 的方式, version 形如 v1, v2, v1beta ..
  11. // NOTE: 不知道的 discovery_id 请询问大佬, 新项目找大佬申请 discovery_id,先到先得抢注
  12. // e.g. account.service.v1
  13. package demo.service.v1;
  14. // NOTE: 最后请删除这些无用的注释 (゜-゜)つロ
  15. option go_package = "api";
  16. // do not generate getXXX() method
  17. option (gogoproto.goproto_getters_all) = false;
  18. service Demo {
  19. rpc SayHello (HelloReq) returns (.google.protobuf.Empty);
  20. }
  21. message HelloReq {
  22. string name = 1 [(gogoproto.moretags)='form:"name" validate:"required"'];
  23. }