别再手写API文档了!AI一键生成OpenAPI规范代码
提示词描述:
适合后端开发者和API设计师,解决API文档编写繁琐、代码与文档不同步的痛点。通过AI一次性生成符合OpenAPI规范的文档和可运行的FastAPI代码,确保接口设计与实现的一致性,提升团队协作效率。
提示语关键词:
AI生成API代码,OpenAPI文档生成,FastAPI接口代码,AI写接口文档,API规范代码生成,AI编程提示词,Python API开发
提示词内容:
你是一位精通API设计和OpenAPI 3.0规范的技术专家,擅长从需求描述自动生成标准化的API接口代码和文档。请根据以下业务场景,为我生成完整的API模块代码和对应的OpenAPI YAML文档。
业务场景描述:我需要开发一个「智能衣橱管理」API服务,核心功能包括:衣物录入(支持图片上传和AI自动识别分类)、穿搭方案生成(基于天气、场合、风格偏好推荐搭配)、衣橱统计(按品类、颜色、使用频率分析)、衣物生命周期管理(穿着次数追踪、清洗提醒、淘汰建议)。
请按以下结构输出:
第一部分:OpenAPI 3.0规范文档(YAML格式),需包含完整的info、servers、paths、components定义。每个接口需包含summary、description、parameters、requestBody、responses,responses需提供成功和典型错误场景的示例。使用$ref引用复用schema定义,确保文档结构清晰。
第二部分:基于FastAPI框架的Python实现代码。路由层按模块拆分(wardrobe、outfit、statistics),使用Pydantic模型进行请求/响应校验。实现以下核心接口:POST /clothing(衣物录入,含图片base64处理和模拟AI分类逻辑)、POST /outfit/recommend(穿搭推荐,需接收天气、场合等参数)、GET /wardrobe/statistics(衣橱统计,返回品类分布、颜色分布等聚合数据)、PATCH /clothing/{id}/lifecycle(更新穿着次数,触发清洗/淘汰提醒逻辑)。
第三部分:中间件和工具函数。实现请求日志记录中间件、统一异常处理、分页工具函数、图片上传处理(支持base64解码和本地存储模拟)。
第四部分:对比分析表格。用Markdown表格对比OpenAPI文档生成方案(手动编写YAML vs 代码注解自动生成 vs AI生成)在维护成本、准确性、开发效率三个维度的优劣。
所有代码需包含类型标注、docstring和基本的输入校验。OpenAPI文档需可通过swagger-ui直接渲染预览。
上一页:AI绘画提示词工程:从入门到精通
下一页:5个代码片段搞定理财收益计算,金融开发者