🔌 API 开发
01 API Development📌 场景描述
🔌 API 开发
REST API 和 GraphQL 接口设计与实现的 Prompt 工程实践
📚 本目录包含
- REST API 接口设计 - 从需求到完整的 REST API 设计文档
- GraphQL Schema - GraphQL 类型定义和查询设计
- API 文档生成 - OpenAPI/Swagger 文档自动生成
- 错误处理 - 统一的错误响应设计
- 验证规则 - 请求参数和数据验证
🎯 场景应用
这些 Prompt 适用于:
- 🔧 新项目的 API 架构设计
- 📋 API 文档的自动生成
- 🔗 前后端接口约定
- 🛡️ 参数验证和错误处理设计
- 📚 API 接口版本管理
💡...
📝 完整 Prompt
# 🔌 API 开发
> REST API 和 GraphQL 接口设计与实现的 Prompt 工程实践
---
## 📚 本目录包含
- **REST API 接口设计** - 从需求到完整的 REST API 设计文档
- **GraphQL Schema** - GraphQL 类型定义和查询设计
- **API 文档生成** - OpenAPI/Swagger 文档自动生成
- **错误处理** - 统一的错误响应设计
- **验证规则** - 请求参数和数据验证
---
## 🎯 场景应用
这些 Prompt 适用于:
- 🔧 新项目的 API 架构设计
- 📋 API 文档的自动生成
- 🔗 前后端接口约定
- 🛡️ 参数验证和错误处理设计
- 📚 API 接口版本管理
---
## 💡 快速开始
1. 打开 **REST API 接口设计** 文件
2. 描述你的业务需求和数据模型
3. 复制对应的 Prompt(基础版或进阶版)
4. 获得完整的 API 设计方案
5. 根据设计文档实现服务端和客户端
---
**🌐 注**: REST API 和 GraphQL 各有优缺点,选择取决于你的具体需求。