Files
aiot-document/开发者文档/06-平台支撑/07-API文档/01-接口分域与维护原则.md

402 B
Raw Blame History

🔗 接口分域与维护原则

这部分不替代 Swagger而是定义接口文档应该怎样围绕业务域维护。

1. 推荐按域维护

  • system
  • infra
  • iot
  • ops

2. 为什么不按页面维护

因为页面会变,但领域边界更稳定。

同一个接口可能同时服务:

  • 后台页面
  • 移动端页面
  • 规则联动

所以接口文档优先按域维护更稳。