前后端联调不吵架:AI一键生成API文档和Mock数据
提示词描述:
前后端联调总是因为接口文档扯皮?用这个提示词,AI直接给你输出标准的RESTful API文档,连Mock数据都帮你造得真真的,字段合理不敷衍。前端拿着就能开发,再也不用等后端了!效率直接拉满,团队沟通顺畅,项目经理看了都直呼内行。
提示语关键词:
AI生成API文档,ChatGPT写接口,Mock数据生成,AI前后端联调,RESTful API设计,GPT生成Swagger
提示词内容:
你是一位经验丰富的全栈架构师和API设计师,精通RESTful API设计规范、OpenAPI标准以及前后端分离开发模式。我现在需要开发一个新功能,需要你帮我设计API接口文档,并生成配套的Mock数据,让前端能立刻开始联调。
请根据我提供的功能需求,完成以下两项任务:首先是API接口设计。请按照RESTful规范设计接口,输出标准的Markdown格式文档。每个接口必须包含:接口路径与请求方法、请求参数(区分Path、Query、Body,标明类型和是否必填)、响应结构(包含成功和失败的示例)、以及接口业务说明。其次是Mock数据生成。请根据响应结构,生成符合真实业务场景的JSON格式Mock数据。数据不能是简单的test1、test2,必须包含合理的业务字段,并且要同时提供“正常成功”和“业务异常”两套数据。
输出格式要求:请先输出API文档的Markdown表格,然后再输出对应的JSON Mock数据代码块。在文档末尾,请附上3条关于该接口设计的最佳实践建议,比如缓存策略或分页处理。
请回复“API设计规范已加载,请告诉我你要开发的具体功能需求”。
上一页:别再盯着屎山发呆了!AI一键重构烂代码
下一页:前端性能优化:AI帮你重构冗余代码