后端架构师都在用:AI生成高可用API接口设计
提示词描述:
面向后端开发者的API架构设计提示词。引导AI按照数据库设计、接口定义、业务逻辑、非功能性设计四个标准步骤,输出包含并发控制、幂等性设计及缓存策略的高可用后端接口蓝图,提升架构设计效率。
提示语关键词:
AI编程,后端开发,AI设计API接口,后端架构提示词,GPT写Java,数据库表设计模板
提示词内容:
【模板说明】
本模板旨在辅助后端开发者进行高可用、高扩展性的API接口架构设计。通过结构化的需求输入,AI能够输出包含数据库设计、接口定义、鉴权策略及异常处理的完整后端开发蓝图。
【使用场景】
适用于后端开发工程师、系统架构师或技术负责人。在承接新业务需求、进行微服务拆分或设计复杂SaaS系统接口时,使用此模板可快速梳理业务逻辑,生成规范的API文档与底层数据模型设计。
【模板正文】
角色:资深后端架构师与数据库专家。
任务:根据业务需求,设计高可用的后端API接口及数据库结构。
技术栈:[填写语言/框架,如Java SpringBoot/Go Gin] + [数据库,如MySQL/PostgreSQL] + [缓存,如Redis]。
业务场景:[简述业务背景,如:电商平台的秒杀活动接口]。
设计步骤清单:
步骤1:数据库表设计。输出核心表结构,包含字段名、类型、注释、索引设计及外键/逻辑删除策略。
步骤2:API接口定义。采用RESTful风格,列出URL、HTTP方法、请求参数(Query/Body)、响应结构(统一包装类)。
步骤3:核心业务逻辑。描述关键流程的状态流转、并发控制策略(如乐观锁/分布式锁)。
步骤4:非功能性设计。明确鉴权方式(JWT/OAuth2)、限流降级策略(如令牌桶算法)、缓存更新机制(Cache Aside)。
约束条件:
- 遵循单一职责原则,接口粒度适中。
- 必须考虑幂等性设计,特别是涉及资金或状态变更的接口。
- 提供核心SQL查询语句及执行计划优化建议。
【填写指南】
1. 业务场景:描述需包含核心实体与关键动作,如'用户下单并扣减库存',避免过于笼统。
2. 技术栈:务必指定具体的ORM框架或中间件,以便AI生成贴合实际技术栈的代码或配置。
3. 设计步骤:严格按照步骤1-4的顺序让AI输出,确保架构设计的完整性与逻辑连贯性。
4. 约束条件:强调幂等性和并发控制,这是区分初级与高级后端设计的关键点。
【效果示例】
输入:Java SpringBoot + MySQL + Redis,场景:文章点赞功能。要求步骤完整,考虑高并发。
输出:AI将输出包含article_like_record表设计(联合唯一索引防重复点赞)、RESTful API定义(POST /api/v1/articles/{id}/like)、基于Redis Lua脚本的原子点赞逻辑,以及基于消息队列的异步落库方案。