clawbot 提供五种生成 grpc 服务定义与客户端代码的方法:一、内置 proto 模板向导;二、openapi/swagger 转换;三、数据库 schema 自动生成;四、cli 批量生成多语言客户端;五、ci/cd 插件自动触发。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如果您使用 ClawBot 工具辅助微服务通信,但尚未生成 gRPC 服务定义(.proto 文件)及对应客户端代码,则可能是由于未正确配置协议描述或缺少代码生成链路。以下是针对 ClawBot 环境下生成 gRPC 服务定义与客户端代码的多种可行方法:
一、通过 ClawBot 内置 proto 模板向导生成 .proto 文件
ClawBot 提供交互式协议定义向导,可自动构建符合 gRPC 规范的 .proto 文件结构,避免手动编写语法错误。该方法适用于快速初始化服务契约,确保 package、message 和 service 声明满足 protoc 编译要求。
1、在 ClawBot 主界面选择「New gRPC Contract」模板。
2、输入服务名称(如 UserService)、请求/响应字段名与类型(如 user_id: int32、email: string)。
3、勾选所需 RPC 类型(一元、服务端流、客户端流或双向流),ClawBot 将自动生成 syntax="proto3" 格式文件并保存为 user_service.proto。
二、导入已有 OpenAPI/Swagger 定义并转换为 .proto
当已有 RESTful 接口文档时,ClawBot 支持将 OpenAPI 3.0 YAML 或 JSON 文件解析为等效的 gRPC 协议定义,实现接口语义对齐与数据结构映射。此方式可复用现有 API 设计资产,降低迁移成本。
1、点击「Import Spec」按钮,上传 openapi.yaml 文件。
2、在映射配置页中,为每个 path 设置对应的 service 名称(如 UserApi)和 method 名称(如 GetUserProfile)。
3、确认字段类型转换规则(例如 OpenAPI 的 integer → proto 的 int32),点击「Generate Proto」输出标准 .proto 内容。
三、基于数据库 Schema 自动生成 .proto 及客户端 stub
ClawBot 可连接 PostgreSQL、MySQL 或 SQLite 实例,读取表结构后推导 message 定义,并为每张主表生成 CRUD 风格的 service 接口。该方法适用于后端数据模型驱动的服务开发场景,保障 proto 与持久层强一致。
1、在「DB to gRPC」模块中填写数据库连接参数(host、port、database、username、password)。
2、选择目标表(如 users),ClawBot 自动识别字段类型并映射为 proto 字段(如 id → int64、created_at → int64)。
3、启用「Generate Client Code」选项,指定语言(Go / Java / Python / C#),ClawBot 调用本地 protoc 与对应插件生成客户端调用类、DTO 类及连接管理器。
四、使用 ClawBot CLI 批量生成多语言客户端代码
对于已存在的 .proto 文件,ClawBot CLI 提供跨平台命令行接口,支持离线批量生成多种语言的客户端存根(stub)与工具类,无需依赖 IDE 插件或图形界面。
1、在项目根目录执行:clawbot grpc generate --proto user_service.proto --lang go --output ./client/go。
2、添加 --with-tests 参数以同步生成单元测试骨架(含 mock server 初始化逻辑)。
3、若需启用 TLS 认证支持,在命令中加入 --tls-enabled,ClawBot 将注入证书加载、Channel 凭据配置等安全相关代码段。
五、通过 ClawBot 插件集成 CI/CD 流水线自动触发生成
在 Jenkins、GitLab CI 或 GitHub Actions 中安装 ClawBot 插件后,可在每次推送 .proto 文件变更时,自动执行代码生成、格式校验与版本兼容性检查,确保客户端代码始终与服务端定义同步。
1、在 CI 配置文件中添加 step:run: clawbot grpc validate --proto ./protos/*.proto。
2、验证通过后执行:clawbot grpc generate-all --dir ./protos --langs python,java。
3、生成结果自动提交至 /gen/clients/ 目录,并触发下游构建任务。











