# API集成技巧 ## 何时使用此技能在以下情况下使用此技能： * 构建一个客户端来使用 REST API * 集成第三方服务 * 实施网络钩子 * 创建或测试 HTTP 端点 * 用户提及“API”、“REST”、“集成”或“HTTP” ## 集成过程 ### 1\. API 发现和规划 **了解API：** * 彻底审查 API 文档 * 识别基本 URL 和 API 版本 * 注意身份验证要求 * 检查速率限制和配额 * 检查错误响应格式 ### 2\.身份验证模式 #### API 密钥 // C# httpClient.DefaultRequestHeaders.Add("X-API-Key", apiKey); // 打字稿 headers: { 'X-API-Key': process.env.API_KEY } #### 不记名令牌 // C# httpClient.DefaultRequestHeaders.Authorization = 新的 AuthenticationHeaderValue("承载者", 令牌); // 打字稿 headers: { '授权': `承载 ${token}` } #### 基本身份验证 // C# var 凭证 = Convert.ToBase64String( Encoding.UTF8.GetBytes($"{用户名}:{密码}") ）； httpClient.DefaultRequestHeaders.Authorization = 新的 AuthenticationHeaderValue("基本", 凭证); ### 3\.客户端实施 #### C# / .NET 公共类 ApiClient { 私有只读 HttpClient _httpClient; 私有只读字符串_baseUrl；公共ApiClient（字符串baseUrl，字符串apiKey） { _httpClient = 新的 HttpClient(); _httpClient.DefaultRequestHeaders.Add("X-API-Key", apiKey); _baseUrl = baseUrl.TrimEnd('/'); } 公共异步任务 GetAsync （字符串端点） { var response = wait _httpClient.GetAsync($"{_baseUrl}/{endpoint}"); 响应.EnsureSuccessStatusCode(); var json = 等待响应.Content.ReadAsStringAsync(); 返回 JsonSerializer.Deserialize(json); } public async Task PostAsync（字符串端点，对象数据） { var json = JsonSerializer.Serialize(数据); var content = new StringContent(json, Encoding.UTF8, "application/json"); var response = wait _httpClient.PostAsync($"{_baseUrl}/{endpoint}", content); 响应.EnsureSuccessStatusCode(); var responseJson =等待response.Content.ReadAsStringAsync(); 返回 JsonSerializer.Deserialize(responseJson); } } #### TypeScript / Node.js 类 ApiClient { 私有baseUrl：字符串；私有 apiKey：字符串；构造函数（baseUrl：字符串，apiKey：字符串）{ this.baseUrl = baseUrl.replace(/\/$/, ''); this.apiKey = apiKey; } 异步 get(端点: string): Promise { const 响应 =等待 fetch(`${this.baseUrl}/${endpoint}`, { headers: { 'X-API-Key': this.apiKey } }); if (!response.ok) throw new Error(`HTTP ${response.status}`); 返回response.json(); } 异步 post（端点：字符串，数据：未知）： Promise { const 响应 =等待 fetch(`${this.baseUrl}/${endpoint}`, { 方法：'POST'，标题：{ 'X-API-Key': this.apiKey, '内容类型'：'应用程序/json' }, 正文：JSON.stringify(数据) }); if (!response.ok) throw new Error(`HTTP ${response.status}`); 返回response.json(); } } ### 4\.错误处理 // C# 公共异步任务 > SafeGetAsync（字符串端点） { 尝试 { var response = wait _httpClient.GetAsync($"{_baseUrl}/{endpoint}"); if (!response.IsSuccessStatusCode) { 返回新的 ApiResult { 成功=错误，错误 = $"HTTP {(int)response.StatusCode}: {response.ReasonPhrase}" }; } var json = 等待响应.Content.ReadAsStringAsync(); var data = JsonSerializer.Deserialize(json); 返回新的 ApiResult { 成功 = true，数据 = 数据 }; } 捕获（HttpRequestException 前） { return new ApiResult { 成功 = false, 错误 = ex.Message }; } } ### 5\.速率限制类 RateLimitedClient { 私有请求队列： (() => Promise)[] = []; 私人处理= false；私有 requestsPerSecond：数量；构造函数（requestsPerSecond：数量）{ this.requestsPerSecond = requestsPerSecond; } 异步入队 (请求: () => Promise): Promise { 返回新的 Promise((解决, 拒绝) => { this.requestQueue.push(async() => { 尝试{ 解决（等待请求（））； } 捕获（错误）{ 拒绝（错误）； } }); this.processQueue(); }); } 私有异步 processQueue() { if (this.processing) 返回； this.处理 = true; while (this.requestQueue.length > 0) { const request = this.requestQueue.shift(); 如果（请求）{ 等待请求（）；等待 this.delay(1000 / this.requestsPerSecond); } } this.处理 = false; } 私人延迟（毫秒：数字）： Promise { 返回新的 Promise(resolve => setTimeout(resolve, ms)); } } ### 6\.重试逻辑 // C# 公共异步任务 GetWithRetryAsync （字符串端点，int maxRetries = 3） { for (int attempts = 1; attempts <= maxRetries; attempts++) { 尝试 { 返回等待 GetAsync(端点); } 当（尝试< maxRetries）时捕获（HttpRequestException） { 等待 Task.Delay(TimeSpan.FromSeconds(Math.Pow(2, 尝试))); } } throw new Exception($"在 {maxRetries} 次尝试后失败"); } ## 最佳实践 1. **使用 HttpClientFactory**（在 .NET 中）进行正确的连接管理 2. **设置超时**以避免挂起请求 3. **记录请求和响应**以进行调试 4. **对请求/响应数据使用强类型模型** 5. **实施断路器**以实现容错 6. **将凭据安全地存储在环境变量或秘密管理器中 7. **使用数据之前验证响应** 8. **处理列表端点的分页**

API集成

包含技能