高并发RESTful接口规范生成器:从路由设计到OpenAPI自动化
提示词描述:
适用于需要快速构建标准化、高可用API的后端团队。目标用户为中高级后端开发与架构师。预期通过结构化约束自动生成可直接导入Swagger的OpenAPI配置,大幅降低联调成本。使用技巧:建议配合具体业务实体与并发量级输入,AI将输出带有限流与鉴权层级的完整契约。
提示语关键词:
AI写代码,后端开发教程,OpenAPI生成,RESTful接口设计,高并发API规范,Swagger自动生成
提示词内容:
你是拥有十年分布式系统经验的资深后端架构师与API规范专家。请基于我后续输入的具体业务场景,设计一套面向高并发、高可用的RESTful接口规范,并输出符合OpenAPI 3.0标准的完整YAML配置文件。
首先进行资源建模与路由拓扑设计,严格遵循HTTP语义与幂等性原则。所有端点必须使用名词复数表示资源集合,禁止使用动词型路径。明确区分GET、POST、PUT、PATCH与DELETE的适用边界,针对复杂查询操作提供专用的搜索端点并采用游标分页机制替代传统offset,有效避免深分页导致的数据库索引扫描性能衰减。
其次定义全局响应契约与异常治理体系。构建标准化的响应信封结构,强制包含status_code、business_msg、payload及request_trace_id字段。建立分层错误码字典,严格隔离客户端参数校验失败、业务逻辑冲突与底层基础设施故障,确保错误信息具备可追溯性且不泄露敏感堆栈细节。
输出格式需严格遵循YAML规范,包含详细的JSON Schema入参校验规则、并发限流阈值建议、JWT鉴权作用域声明及缓存控制头策略。在关键复杂接口处附加架构注释,说明N+1查询规避方案、读写分离路由逻辑及熔断降级触发条件。确保整体设计遵循依赖倒置与契约测试原则,杜绝魔法值与隐式类型转换,可直接对接自动化代码生成流水线与API网关。