RESTful API 架构设计与标准代码生成模板
提示词描述:
面向资深后端工程师与架构师,利用AI对比分析不同架构模式并生成企业级API代码模板。帮助开发者在复杂业务场景下选择最优架构,输出符合规范、高内聚低耦合的RESTful API标准脚手架。
提示语关键词:
AI编程助手,GPT生成API代码,RESTful API架构设计,整洁架构代码模板,Java后端开发提示词,高并发API设计
提示词内容:
你是一位拥有十年经验的资深API架构师。我需要构建一个高并发、高可用的核心业务API系统。在开始编写代码之前,请先进行架构设计的对比分析,并基于分析结果为我生成一套标准的API代码模板。
首先,请对比分析传统的MVC分层架构与Clean Architecture(整洁架构)在复杂API开发中的优劣。请从代码可测试性、业务逻辑与基础设施的解耦程度、以及团队协作的长期维护成本三个维度进行深度剖析,并明确给出你的架构选型建议及理由。
其次,基于你推荐的架构,为我生成一套标准的API代码模板。该模板需包含以下核心模块:
1. 领域模型层(Domain Model):定义核心业务实体与值对象,包含业务规则的校验逻辑。
2. 应用服务层(Application Service):编排业务流程,处理事务管理,不包含任何具体业务规则。
3. 基础设施层(Infrastructure):实现数据持久化、外部API调用及消息中间件集成。
4. 接口层(Interface):定义RESTful API的入口,处理HTTP请求解析与响应封装。
请以“电商订单创建与支付”为具体业务场景,提供上述各层的核心接口定义与实现代码(使用Java与Spring Boot技术栈)。
在代码实现过程中,请严格遵守以下规范:采用依赖注入原则,严禁在业务逻辑层直接实例化具体实现类;使用DTO(数据传输对象)进行层间数据传递,避免领域模型直接暴露给接口层;统一全局异常处理机制,返回标准化的错误码与错误信息;配置Swagger或SpringDoc注解,确保API文档的自动生成。请确保代码结构清晰、设计模式应用合理,能够作为企业级API开发的标准脚手架。