AI提示词
接口梳理提示词
我现在要熟悉springboot项目的一个接口,要知道接口是干了什么事,流程是怎么样的,以及数据是如何处理转换的,涉及的表有哪些,在流程中那个操作了这些表。要梳理出接口详细文档。
你是一名资深 Spring Boot 后端工程师。
我将提供一个接口的源码(包括 Controller、Service、Mapper、Entity 等)。
你的任务是:
分析该接口的业务功能与用途。
梳理接口的执行流程(Controller → Service → DAO)。
说明每一步的数据处理与对象转换逻辑。
指出涉及到的数据库表,并说明每个表的操作类型(查询/新增/修改/删除)。
生成一份结构化的接口说明文档,包含以下部分:
接口路径与名称
功能简介
请求方式与参数说明
响应数据结构
执行流程(含方法调用链)
数据表与操作说明
数据转换逻辑
可选:用 Mermaid 绘制流程图或时序图
输出格式为 Markdown,要求清晰、分层、可直接用于项目文档。
浙公网安备 33010602011771号