用于定义协议缓冲区中的 API 的校验器。
API linter 可实时检查是否符合 Google 许多的规范。 API 标准,使用 [API 改进建议] 进行记录。它基于 [协议缓冲区] 中定义的 API 表面。 它识别了 API 表面中的常见错误和不一致性:
// Incorrect.
message GetBookRequest {
// This is wrong; it should be spelled `name`.
string book = 1;
}如果能够,它还会提供正确修复的建议。
Google API linter 不遵循语义版本管理。语义 对于像 linter 这样的工具来说,版本管理是一项具有挑战性的任务,因为添加或删除代码会 修改几乎任何规则都属于"破坏" (从这个意义上说,修改文件会导致文件的内容发生变化)。 之前未报告的问题现在可能会出现)。
因此,版本号指的是 linter 的核心接口。一般来说:
如果您有兴趣为 API linter 进行贡献,请查看 贡献指南 以了解更多信息。
Read more ≫ [apache 2.0]: https://www.apache.org/licenses/LICENSE-2.0 [api improvement proposals]: https://aip.dev/ [protocol buffers]: https://developers.google.com/protocol-buffers [rule documentation]: ./rules/index.md
暂无开放 Issues,或尚未同步最近议题。