DiagramPreview
高级预览Live previewExportDeveloper tool

Protobuf Schema 可视化

粘贴 .proto schema，把 message、字段、枚举、service 和引用关系展示为更容易 review 的图。

示例
预览结果就绪
预览结果会显示在这里。

下一步可以继续

把当前预览结果带到相关工具里继续转换、排查或导出。

SQL 转 ER 图

从 CREATE TABLE SQL 生成 ER 图，检查表、主键、外键和关系。

打开
JSON Schema 可视化

查看 JSON Schema 属性、类型、必填字段、枚举、数组 item 和 oneOf/anyOf 结构。

打开
JSON Schema 表单预览

把 JSON Schema 的属性、必填项、枚举和格式转换成表单预览。

打开

使用方法

  1. 1粘贴 .proto schema 或加载 message/service 示例。
  2. 2检查 message、字段、repeated 关系、enum、service、request 和 response 类型。
  3. 3评估变更时同时检查 field number、reserved 字段和 enum 默认值。
  4. 4大型 proto 按 package 或 service 拆分后再做文档。
  5. 5导出可视化结果用于 API 文档、SDK 说明或 schema review。

常见场景

Protobuf API 契约 reviewSDK 文档Message 关系图Schema 演进 reviewAI 生成 proto 校验

相关工具

SQL 转 ER 图

从 CREATE TABLE SQL 生成 ER 图，检查表、主键、外键和关系。

JSON Schema 可视化

查看 JSON Schema 属性、类型、必填字段、枚举、数组 item 和 oneOf/anyOf 结构。

JSON Schema 表单预览

把 JSON Schema 的属性、必填项、枚举和格式转换成表单预览。

常见问题

这个工具用来做什么？

把 protobuf message、字段和引用关系可视化，方便看懂 API 契约和数据结构。

需要账号吗？

不需要，工具页可以直接在浏览器里使用。

能帮助 review protobuf schema 变更吗？

可以。图能更清楚展示 message 引用、repeated 字段、enum 和 service request/response 形状。

视觉变化能证明 wire compatibility 吗？

不能。兼容性取决于 field number、reserved 字段、enum 行为和客户端生成代码预期。

service 文档应包含什么？

包含 service block、request message、response message、相关 enum，以及客户端需要理解的嵌套 message。

Protobuf Schema 可视化适合 API 契约 review、SDK 文档和 proto 文件结构检查。

粘贴 protobuf schema 后，可以把 message、字段、repeated 关系、enum、service 请求响应类型看成更容易理解的结构图。

发布 schema 变更、检查 AI 生成 proto 示例或整理开发文档前，先用预览确认结构是否符合预期。

Demo：映射 protobuf message 和引用

Protobuf 文件很紧凑，但 message 引用和 repeated 字段变成类图后更容易检查。

  • 分开展示普通字段、enum 字段和 repeated 关系。
  • 跨 service 的 schema 保留 package 名。
  • 用图 review API 契约，不要只靠图判断二进制兼容。
message Order {
  string id = 1;
  repeated OrderItem items = 2;
  OrderStatus status = 3;
}
message OrderItem { string sku = 1; int32 qty = 2; }

兼容性清单：可视化变更但不替代规则

Protobuf 演进时，视觉 diff 很有帮助，但兼容性仍由 field number 和 wire behavior 决定。

  • 不要复用已删除字段的 field number。
  • 删除旧字段时标记 reserved。
  • 检查 enum 默认值和未知值处理。
reserved 4, 7;
reserved "legacy_status";

Service 文档：把 RPC 和 message 形状连起来

API 文档中，protobuf 图应把 service method 与 request/response message 放在一起，让 SDK 用户不必阅读整份 proto。

  • 每个 RPC 旁边显示 request 和 response。
  • 控制客户端行为的 enum 要可见。
  • 说明可能很大的 repeated 字段。
service OrderService {
  rpc GetOrder (GetOrderRequest) returns (Order);
}
message GetOrderRequest { string id = 1; }

Protobuf Schema 可视化 检查清单

当你需要在文档、PR、故障复盘或交接材料发布前检查源码内容时，可以使用 Protobuf Schema 可视化。把 .proto 中的 message、字段、enum、service 和引用关系可视化。

导出前建议检查标签是否可读、关系是否和源码一致、示例是否包含敏感信息，以及修改输入后预览是否仍然成立。

限制与排查

如果预览失败，先把输入缩小到最小完整示例，确认格式语法，再逐段加回内容。很多失败来自不完整文件、缩进错误、缺少图表头，或复制了依赖隐藏上下文的片段。

请把预览结果当作 review 界面，而不是生产事实来源。生成的图表、转换文件、看板和规则示例在进入正式文档或运维流程前仍需要人工确认。

可测试的示例输入

  • Orders: syntax = "proto3"; message Order { string id = 1; User user = 2; repeated Item items = 3; } message User { string id = 1; string email = 2; } message Item { string sku = 1; int32 q...
  • Events: message Event { string id = 1; string type = 2; Payload payload = 3; } message Payload { string json = 1; }
  • Service: service OrderService { rpc GetOrder (GetOrderRequest) returns (Order); } message GetOrderRequest { string id = 1; } message Order { string id = 1; }

工具完成度

高级预览

高级解析

这个工具会从开发者输入中提取结构和关系，适合调试与文档 review；复杂边界仍建议回到源码确认。

分级不是质量打分，而是告诉用户当前工具更适合稳定导出、深度调试、快速解析，还是 AI 辅助生成。