技能与规则/Proto Review
技能与规则
说明 apihug-proto-review 如何按 ApiHug 规则检查 protobuf 设计。
apihug-proto-review 用来判断当前契约设计是否仍然符合 ApiHug protobuf 规则。
这个技能评审的是 protobuf 契约本身,而不是生成后的代码。
契约弱,生成物就会弱。Proto review 的价值在于:在问题扩散到代码、SDK 和集成层之前,先把建模偏差拦下来。
它重点关注这些方面:
它通常应该抓住的问题包括:
评审时,把这些规则文档当作依据:
apihug-proto-api-extension-guideapihug-proto-database-modeling-guideapihug-proto-enum-error-extension-guide