如何基于Protobuf动态构建gRPC请求消息的示例JSON？

直接可用的命令行工具 #

• grpcurl自带反射生成模板：如果你的gRPC服务开启了反射功能，无需额外工具，直接用grpcurl就能生成对应请求消息的JSON模板，自动解析嵌套字段和外部导入的Protobuf定义。命令示例：

  # 查看方法的请求消息结构
  grpcurl -plaintext localhost:5000 describe myService.method
  # 生成空结构的JSON模板
  grpcurl -plaintext -d '{}' localhost:5000 myService.method --dry-run
  

  生成的模板你只需填充具体测试值，就能直接用于grpcurl调用。

• protoc-gen-mockjson插件：这是专门生成Protobuf消息模拟JSON的protoc插件，安装后执行以下命令，会直接输出每个消息类型的示例JSON文件，包含默认值或随机测试数据：

  protoc --mockjson_out=./ your_service.proto
  

基于JSON Schema的简化实现 #

你提到的protoc-gen-jsonschema转换Protobuf到JSON Schema后，不用自己复杂编程构建示例，用现成工具就能生成：

• 用Python的jsonschema库，几行代码即可生成符合Schema的示例JSON：

  import json
  from jsonschema import examples
  
  # 加载protoc-gen-jsonschema生成的schema文件
  with open("request_schema.json") as f:
      schema = json.load(f)
  
  # 生成示例JSON并格式化输出
  example = examples.generate(schema)
  print(json.dumps(example, indent=2))
  

  该方法会自动处理嵌套结构和外部依赖的Protobuf字段，生成的结果可直接存为文件给grpcurl使用。

内容的提问来源于stack exchange，提问作者hellojoshhhy