mcpField
A
api-response-optimization

api-response-optimization

github.com/aj-geddes开发373486 次安装34 周前更新
代码仓库

关于 api-response-optimization

这项技能围绕响应载荷、缓存和查询效率优化 API 性能，适合处理响应缓慢、资源占用高或扩展瓶颈的开发者，并提供相关参考指南。

主要功能

  1. 01优化响应载荷
  2. 02缓存策略
  3. 03压缩与性能指南
  4. 04优化检查清单

适用场景

  1. 01缩减过大的 API 响应
  2. 02处理响应缓慢问题
  3. 03扩展期间检查 API 性能

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill api-response-optimization

安装后在 Claude Code 中输入/api-response-optimization确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
caching-strategies.md
compression-performance.md
optimization-checklist.md
response-payload-optimization.md
scripts/
validate-api.sh
templates/
api-scaffold.yaml

详细介绍

API 响应优化

目录

概述

快速的 API 响应能提升应用的整体性能和用户体验。优化重点在于负载大小、缓存和查询效率。

适用场景

  • API 响应时间缓慢
  • 服务器 CPU/内存占用过高
  • 响应负载过大
  • 性能下降
  • 扩展瓶颈

快速入门

最简可运行示例：

// Inefficient response (unnecessary data)
GET /api/users/123
{
  "id": 123,
  "name": "John",
  "email": "[email protected]",
  "password_hash": "...", // ❌ Should never send
  "ssn": "123-45-6789", // ❌ Sensitive data
  "internal_id": "xyz",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-02T00:00:00Z",
  "meta_data": {...}, // ❌ Unused fields
  "address": {
    "street": "123 Main",
    "city": "City",
    "state": "ST",
    "zip": "12345",
    "geo": {...} // ❌ Not needed
  }
}

// Optimized response (only needed fields)
GET /api/users/123
{
  "id": 123,
// ... (see reference guides for full implementation)

参考指南

references/ 目录中的详细实现：

指南内容
响应负载优化响应负载优化
缓存策略缓存策略
压缩与性能压缩与性能
优化检查清单优化检查清单

最佳实践

✅ 应该做
  • 遵循既定的模式和约定
  • 编写整洁、易维护的代码
  • 添加适当的文档
  • 部署前进行全面测试
❌ 不应该做
  • 跳过测试或验证
  • 忽略错误处理
  • 将配置值硬编码

评论

支持 Markdown