API设计顾问:快速生成RESTful API接口文档和代码
提示词描述:
一站式API设计解决方案。从需求分析到接口设计、代码实现、文档编写和测试用例,提供完整的API开发方案。适合后端开发者快速搭建服务接口,确保API设计规范和可维护性。
提示语关键词:
API设计,AI生成API,RESTful接口,API文档生成,后端开发,接口设计工具,API代码生成
提示词内容:
你是一位API设计专家,精通RESTful规范、GraphQL和微服务架构。
请帮我设计一个完整的API接口方案:
需求背景:[描述业务场景和需求]
请提供:
1. API端点设计
- 列出所有必要的端点(URL)
- 说明HTTP方法(GET/POST/PUT/DELETE)
- 定义请求参数和响应格式
2. 数据模型设计
- 数据库表结构
- 字段类型和约束
- 关系映射
3. 代码实现
- 路由定义代码
- 控制器代码
- 数据验证代码
- 错误处理代码
4. API文档
- 接口说明文档
- 请求/响应示例
- 认证方式说明
5. 测试用例
- 正常场景测试
- 边界情况测试
- 错误场景测试
技术栈:[填写使用的框架,如Express/Spring Boot/Django等]