安装并使用 claude-api,通过 Claude API、Anthropic SDK 和 Agent SDK 模式,在多种后端语言中构建应用。

Stars0
收藏0
评论0
分类API 开发
安装命令
npx skills add https://github.com/anthropics/skills --skill claude-api
概览

Overview

claude-api 能帮你做什么

claude-api 这个 skill 是一份实用参考,帮助你基于 Claude API、官方 Anthropic SDK,以及在可用情况下提供的 Agent SDK 资料,构建由 LLM 驱动的应用。它按语言组织内容,方便开发者快速从环境准备进入可运行的请求、流式响应、工具调用以及后端集成模式。

如果你已经明确要使用 Claude,需要的是落地实现指导,而不是泛泛的 AI 概览,那么这个 skill 尤其有用。仓库中包含面向 C#、Go、Java、PHP、Ruby、Python 和 TypeScript 的语言专属文档,也提供了放在 curl/ 下的原始 HTTP 示例。

适合哪些人使用

claude-api 特别适合:

  • 需要将 Claude 集成到服务、worker 和内部工具中的后端开发者
  • 在直接调用 HTTP 和官方 SDK 之间做选型的 API 开发者
  • 在 Python、TypeScript、Go、Java、PHP、Ruby 或 C# 之间比较语言支持、准备统一技术栈的团队
  • 需要流式输出、工具调用、批处理、Files API 用法和错误处理示例的开发者
  • 使用 Python 或 TypeScript Agent SDK 资料构建 agent 的开发者

它解决了什么问题

claude-api 不需要你从零拼凑分散的示例,而是为常见实现决策提供了一个结构化起点:

  • 该使用哪个 SDK 或 API 接口
  • 应该先看哪个语言目录
  • 如何通过 ANTHROPIC_API_KEY 完成认证
  • 如何发送第一条 message 请求
  • 什么时候更适合用流式输出处理长内容
  • 去哪里查看工具调用、batch、Files API、prompt caching、模型参考和错误码

这个 skill 还包含一些共享参考文件,例如 shared/error-codes.mdshared/models.mdshared/prompt-caching.mdshared/live-sources.mdshared/tool-use-concepts.md。当你需要的不只是一个最简 hello-world 示例,而是更完整的后端行为指引时,这些内容会很有帮助。

仓库中支持的文档范围

从仓库结构来看,主要包括这些部分:

  • csharp/
  • curl/
  • go/
  • java/
  • php/
  • python/agent-sdk
  • python/claude-api
  • ruby/
  • typescript/agent-sdk
  • typescript/claude-api
  • shared/

这意味着 claude-api 不只是一个单语言代码片段合集。更准确地说,它是面向 Claude API 生态的多语言后端集成 skill。

什么情况下 claude-api 很适合你

在以下场景中,建议使用 claude-api

  • 你的代码库会引入 anthropic@anthropic-ai/sdkclaude_agent_sdk
  • 你希望采用官方 Anthropic SDK 的使用模式
  • 你需要服务端集成 Claude API 的实用示例
  • 你想在真正开始实现前,先看按语言整理好的安装指引
  • 你需要理解 streaming、tool use、batches 或 Files API support 等功能

什么情况下 claude-api 不太适合

以下情况下,这个 skill 可能不是最佳选择:

  • 你的项目使用的是其他 AI 提供商的 SDK,例如 openai
  • 你需要的是与 Claude 集成无关的通用编程帮助
  • 你寻找的是前端 UI 模式,而不是 API 和后端工作流
  • 你需要仓库未覆盖的语言,并且也不打算使用 curl/ 中的原始 HTTP 示例

How to Use

安装这个 skill

从 Anthropic skills 仓库添加 claude-api

npx skills add https://github.com/anthropics/skills --skill claude-api

安装完成后,先从 SKILL.md 开始,再进入与你代码库对应的语言目录。

先选对目录

想高效使用 claude-api,最快的方法就是先确定对应的语言路径,再去看具体实现细节。

仓库中比较合适的起点包括:

  • SKILL.md
  • csharp/claude-api.md
  • curl/examples.md
  • go/claude-api.md
  • java/claude-api.md
  • php/claude-api.md
  • ruby/claude-api.md
  • python/claude-api/README.md
  • typescript/claude-api/README.md
  • python/agent-sdk/README.md
  • typescript/agent-sdk/README.md

如果你还在评估 SDK 支持、尚未决定技术栈,可以并排查看几个语言目录。仓库对 Python 和 TypeScript 中的直接 Claude API 用法与 Agent SDK 指南做了清晰区分。

按使用场景匹配对应能力

根据仓库结构,claude-api 支持几条很实用的路径:

  • 使用 curl/examples.md 查看原始 HTTP 请求,或用于未覆盖的语言
  • 使用 go/java/php/ruby/csharp/ 等语言目录查看官方 SDK 模式
  • 使用 python/claude-api/typescript/claude-api/ 深入了解 streaming、tool use、batches 和 Files API 等主题
  • 如果你的项目重点是 agent 工作流,而不仅仅是直接的 message 调用,可使用 python/agent-sdk/typescript/agent-sdk/

这种结构很适合做安装和选型判断,因为并不是每种语言都具备相同的高阶特性。比如仓库明确提供了 Python 和 TypeScript 的 Agent SDK 文档,而其他语言则更侧重 Claude API SDK 的使用。

安全配置认证信息

在整个仓库的示例里,标准做法都是使用 ANTHROPIC_API_KEY 环境变量,而不是把密钥硬编码进代码。这也让 claude-api 更适合面向生产环境的后端工作流和 CI 环境。

在测试示例之前,先确认你的运行环境能够正确读取 ANTHROPIC_API_KEY

各语言的典型安装方式

从仓库内容可以看到这些安装示例:

  • C#: dotnet add package Anthropic
  • Go: go get github.com/anthropics/anthropic-sdk-go
  • PHP: composer require "anthropic-ai/sdk"
  • Ruby: gem install anthropic
  • Java: 使用 com.anthropic:anthropic-java 配置依赖
  • 原始 HTTP:用 curl 调用 https://api.anthropic.com/v1/messages

如果你在 SDK 和 HTTP 之间做选择,通常建议优先用已支持语言的 SDK;如果你需要更底层的请求控制,或者所用语言不在覆盖范围内,再切换到 curl/ 示例。

从一个基础 message 请求开始

claude-api 中的大多数语言指南,都会从同样一套实用流程开始:

  1. 初始化 client
  2. 从环境变量读取 API key
  3. 使用 Claude 模型发送一条 message 请求
  4. 从响应中读取文本块

这种一致性对跨多种后端语言协作的团队很有帮助。即使代码语法不同,也能统一请求模式。

长响应建议使用流式输出

仓库中的 SKILL.md 明确建议:对于可能包含长输入、长输出,或较高 max_tokens 的请求,默认优先考虑使用流式输出,因为这样有助于避免请求超时。这是 claude-api 中非常重要的一条实践建议。

如果你的应用会生成较长回答、摘要、工具循环或较长链路的推理结果,建议优先查看以下 streaming 文档:

  • python/claude-api/streaming.md
  • typescript/claude-api/streaming.md
  • 各语言文件中的 streaming 章节,例如 go/claude-api.mdjava/claude-api.mdruby/claude-api.mdcsharp/claude-api.md

深入了解高级后端能力

与其只看一个 quickstart,不如安装 claude-api 的一个重要原因,就是仓库对更深入主题有更完整的覆盖。相关文件包括:

  • python/claude-api/tool-use.md
  • typescript/claude-api/tool-use.md
  • python/claude-api/batches.md
  • typescript/claude-api/batches.md
  • python/claude-api/files-api.md
  • typescript/claude-api/files-api.md
  • shared/tool-use-concepts.md
  • shared/prompt-caching.md
  • shared/models.md

如果你的后端工作流需要的不只是单次请求—响应示例,而是更接近生产环境的能力,这些内容尤其有价值。

排查问题时可优先看共享参考资料

如果首次集成没有成功,claude-api 还提供了一些便于排障和规划的辅助资料:

  • shared/error-codes.md:查看 HTTP 错误含义、是否可重试以及常见原因
  • shared/models.md:查看模型相关参考
  • shared/live-sources.md:查看 source 相关指引

其中错误码参考尤其有用,因为它区分了 429500529 这类可重试情况,以及 400 这类不可重试的请求问题,或 401 这类认证问题。

在项目中采用 claude-api 前的实用检查清单

在项目里决定使用这个 skill 之前,可以先问自己:

  • 我们是否需要某种已支持语言下的官方 SDK 示例?
  • 我们是否会遇到长输出,因此需要 streaming 指引?
  • 我们是否需要 tool use、Files API 或 batch 处理示例?
  • 我们是否在用 Python 或 TypeScript 构建 agent 工作流?
  • 我们是否希望保留一个基于 curl 的原始 HTTP 兜底方案?

如果其中有几项答案是肯定的,那么 claude-api 很可能就是一个合适的选择。

FAQ

这个仓库里的 claude-api 是什么?

claude-apianthropics/skills 中的一个 skill,帮助开发者基于 Claude API、Anthropic SDK 和 Agent SDK 相关资源构建应用。它按语言组织,并由共享参考文档提供补充支持。

如何安装 claude-api?

使用:

npx skills add https://github.com/anthropics/skills --skill claude-api

然后打开 SKILL.md,再进入与你技术栈对应的语言目录。

claude-api 覆盖哪些语言?

从仓库内容来看,文档覆盖 C#、Go、Java、PHP、Ruby、Python、TypeScript,以及基于 curl 的原始 HTTP 示例。

claude-api 包含 Agent SDK 指南吗?

包含。但根据仓库结构,Agent SDK 资料主要位于 python/agent-sdk/typescript/agent-sdk/。如果你需要 agent 工作流示例,建议先看这两个目录。

claude-api 对 streaming 和 tool use 有帮助吗?

有。仓库包含 streaming 和 tool use 文档,尤其在 Python 和 TypeScript 的 Claude API 目录中更完整,而且多个语言专属指南里也提供了 streaming 章节。

claude-api 只适用于直接调用 API 吗?

不是。它同时覆盖直接使用 Claude API 和基于 SDK 的集成模式。对于不想使用 SDK 或正在使用其他语言的开发者,它还在 curl/examples.md 中提供了原始 HTTP 示例。

什么情况下应该用 curl,而不是 SDK?

当你需要原始 HTTP 示例、当前语言没有这个 skill 覆盖的官方 SDK,或者你想在引入 client library 之前先直接查看请求和响应结构时,可以使用 curl

claude-api 包含错误处理相关指引吗?

包含。shared/error-codes.md 记录了 HTTP 错误码、常见原因,以及哪些问题可以重试。因此 claude-api 不只适合做初始接入,也适合用于生产集成规划。

claude-api 适合作为通用编程帮助吗?

不适合。仓库内容聚焦于 Claude API 和 Anthropic SDK 的使用。如果你的任务与 Claude 集成无关,这个 skill 就过于垂直了。

安装 claude-api 后,应该先看什么?

先看 SKILL.md,然后再进入与你的语言和使用场景对应的文件。对很多团队来说,比较推荐的顺序是:

  1. SKILL.md
  2. 你的语言指南,例如 go/claude-api.mdphp/claude-api.md
  3. 主题文档,例如 streaming.mdtool-use.mdbatches.mdfiles-api.md
  4. 共享参考资料,例如 shared/error-codes.md

评分与评论

暂无评分
分享你的评价
登录后即可为这个技能评分并发表评论。
G
0/10000
最新评论
保存中...