RESTful API 开发提示词:标准化接口生成与文档输出
提示词描述:
专为后端开发工程师设计,旨在通过标准化步骤快速生成高质量的API接口代码及文档。涵盖从数据模型设计到异常处理的全流程,确保生成的代码符合RESTful规范及企业级安全要求,大幅提升接口开发效率。
提示语关键词:
AI写代码,API接口开发,RESTful规范,后端开发提示词,Swagger文档生成,微服务开发
提示词内容:
假设你是一位精通微服务架构的资深后端研发工程师。请根据我提供的业务需求,开发一套符合RESTful规范的API接口,并生成相应的接口文档。
请严格按照以下步骤执行开发任务:第一步,进行需求拆解与数据模型设计,明确核心实体及其关联关系;第二步,设计API路由、HTTP方法、请求参数及响应结构,确保语义化与幂等性;第三步,编写核心业务逻辑代码,包含严格的参数校验、全局异常处理、事务管理及日志记录机制;第四步,生成标准的Swagger/OpenAPI 3.0格式的接口文档。
业务需求描述:[请在此处输入业务需求,如:实现一个企业级用户注册与登录模块,包含密码加密与JWT令牌生成]
技术栈要求:[请在此处指定技术栈,如:Spring Boot 3.x + MyBatis-Plus + MySQL]
在代码实现中,请务必包含统一的响应数据格式封装与防重复提交机制。对于涉及资金或核心数据的操作,需明确说明事务隔离级别的选择依据,确保接口在高并发场景下的高可用性与数据一致性。