🔌 API开发专家

设计优雅的API接口,构建高质量的服务端应用!

1. RESTful API设计

遵循RESTful设计原则,创建清晰、一致、易用的API接口。

🎯 提示词模板:

  • 身份设定:请扮演一位"API设计专家",具有丰富的RESTful API设计经验。
  • 目标清晰性:帮助我设计[具体业务场景]的RESTful API。
  • 具体要求:包括资源定义、URL设计、HTTP方法选择、状态码规范和数据格式。

💡 使用示例:

"请扮演一位'API设计专家',帮助我设计博客系统的RESTful API。需要支持文章的增删改查、分类管理、用户评论功能。请提供完整的API设计方案,包括URL路径、HTTP方法、请求参数、响应格式和错误处理。"

2. API文档编写

编写清晰完整的API文档,让开发者能够快速理解和使用API。

🎯 提示词模板:

  • 身份设定:请扮演一位"技术文档专家",专精API文档的编写和维护。
  • 目标清晰性:帮助我为[具体API]编写专业的技术文档。
  • 具体要求:包括接口描述、参数说明、示例代码、错误码定义和最佳实践。

💡 使用示例:

"请扮演一位'技术文档专家',帮助我为用户认证API编写文档。API包含注册、登录、刷新token、找回密码等功能。请提供包含接口概述、认证方式、请求示例、响应格式、错误处理的完整文档模板。"

3. API性能优化

优化API性能,提高响应速度,支持高并发访问。

🎯 提示词模板:

  • 身份设定:请扮演一位"API性能优化专家",精通高性能API开发。
  • 目标清晰性:帮助我优化[具体API场景]的性能问题。
  • 具体要求:包括缓存策略、数据库优化、并发处理和性能监控方案。

💡 使用示例:

"请扮演一位'API性能优化专家',帮助我优化电商商品搜索API的性能。当前API在高并发时响应时间超过2秒,需要优化到500ms以内。请提供包含搜索索引优化、缓存策略、分页方案、数据库查询优化的完整性能提升方案。"

4. API安全防护

构建全面的API安全防护体系,保护数据安全,防范各种攻击。

🎯 提示词模板:

  • 身份设定:请扮演一位"API安全专家",精通Web安全和API防护。
  • 目标清晰性:为[具体API系统]设计全面的安全防护方案。
  • 具体要求:包括身份认证、权限控制、输入验证、防攻击措施和安全监控。

💡 使用示例:

"请扮演一位'API安全专家',为金融支付API设计安全防护方案。API处理敏感的支付信息,需要防范SQL注入、XSS、CSRF等攻击。请提供包含JWT认证、参数加密、请求签名、频率限制、安全审计的完整安全架构。"

5. API版本管理

设计合理的API版本管理策略,确保向后兼容性和平滑升级。

🎯 提示词模板:

  • 身份设定:请扮演一位"API架构师",专精API生命周期管理。
  • 目标清晰性:帮助我制定API版本管理和升级策略。
  • 具体要求:包括版本命名规则、兼容性保证、废弃策略和迁移方案。

💡 使用示例:

"请扮演一位'API架构师',为我们的SaaS平台制定API版本管理策略。平台有100+客户使用API,需要新增功能但要保证现有客户不受影响。请提供包含版本命名、URL设计、兼容性测试、客户迁移通知的完整版本管理方案。"

6. API测试与监控

建立完善的API测试体系和监控机制,确保API质量和稳定性。

🎯 提示词模板:

  • 身份设定:请扮演一位"API质量专家",专注于API测试和运维监控。
  • 目标清晰性:帮助我建立API质量保障体系。
  • 具体要求:包括自动化测试、性能测试、监控告警和故障处理流程。

💡 使用示例:

"请扮演一位'API质量专家',帮助我建立微服务API的测试和监控体系。系统有50个微服务,API接口200+。请提供包含单元测试、集成测试、契约测试、性能测试、实时监控、告警机制的完整质量保障方案。"

← 返回提示词导航