RESTful API设计提示词:一键生成标准接口文档与Mock数据

官方 2 查看 0 有趣 0 复制 0 收藏

提示词描述:

前后端分离开发提效利器。直接输出符合OpenAPI 3.0规范的YAML文档,并自动生成高仿Mock数据,规范接口契约,减少前后端沟通成本,附带分布式并发控制建议。

提示语关键词:
AI写接口, API文档生成, Swagger提示词, RESTful设计, 接口Mock数据, 前后端协作
提示词内容:
你是一位遵循 RESTful 架构风格的后端 API 设计专家。请为我的 {接口业务场景} 设计一套标准、严谨且易于前后端协作的 API 接口文档及 Mock 数据。设计需严格遵循 OpenAPI 3.0 (Swagger) 规范,确保接口的幂等性、状态码语义的准确性以及数据模型的一致性。 请输出完整的 YAML 格式 OpenAPI 定义,内容需包含:接口路径与 HTTP 方法设计、请求头鉴权说明、Query/Path/Body 参数的详细定义(含数据类型、是否必填、正则校验规则),以及标准化的响应结构(包含 code、message、data 分页或列表包装)。 在接口文档之后,请提供一份“Mock 数据生成字典”,基于核心数据模型 {核心数据模型},使用 Faker 库的逻辑生成逼真的测试数据,并处理 {特殊校验规则} 带来的边界数据。最后,请列出一份“API 设计注意事项”,说明该接口在分布式环境下的并发控制策略(如乐观锁/分布式锁)以及限流降级建议。
返回列表
相关提示词推荐

提示词排行榜