09|接口和数据模型:让 AI 产出生成接口清单和 Schema
Robert

你好,我是 Robert。
上一讲画完了三张俯视图,系统级有了架构图、代码级有了模块图、生态级有了依赖图。三种粒度的俯视摆在 docs/ 里,你和 AI 对这个项目有了第一层共识,通过俯视告诉你“项目长什么样”,但它没告诉你“项目怎么被调用”和“项目在处理什么数据”,而这就是本节课要讲的内容。
对应八步心法第 5 步:梳理接口和数据模型。梳理完你会拿到两份新的资产:一份 REST 接口清单和一份核心数据模型说明,都住进 docs/ 里。

接口和数据模型为什么要一起梳理
你可能会想,接口和数据模型是两件事,为什么合在一节课讲?因为它们是项目的门面和根基,彼此绑定。
接口是门面。外部世界通过接口和这个项目打交道。前端调什么 API、三方集成请求什么端点、运维连什么管理接口,全是接口。接口清单决定了“这个项目对外承诺了什么”。
数据模型是根基。接口处理的每一个请求、返回的每一份响应,背后都对应某些数据结构的流动。Prompt 对象长什么样、Dataset 的字段有哪些、Evaluator 的结果存成什么格式,这些是项目的内部骨骼。
两者绑定的原因:接口的参数和返回,90% 的情况下是数据模型的某种映射或变形。接口 POST /api/prompts/create 的请求体基本就是 Prompt 数据模型的子集,响应基本就是 Prompt 的一个视图。接口和数据模型画不清楚,就看不出这个项目的真实形状。
公开
同步至部落
取消
完成
0/2000
笔记
复制
AI
- 深入了解
- 翻译
- 解释
- 总结
仅可试看部分内容,如需阅读全部内容,请付费购买文章所属专栏
《Claude Code 企业级老项目改造实战》,新⼈⾸单¥59
《Claude Code 企业级老项目改造实战》,新⼈⾸单¥59
立即购买
© 版权归极客邦科技所有,未经许可不得传播售卖。 页面已增加防盗追踪,如有侵权极客邦将依法追究其法律责任。
登录 后留言
精选留言
由作者筛选后的优质留言将会公开显示,欢迎踊跃留言。
收起评论