← 返回API 开发
API 开发 / 第 01 课

理解一次 API 调用的输入与输出

API 让应用能够通过程序与模型协作。开始写代码之前,先理解数据如何进来、结果如何出去。

学完这一课,你将能够

说清楚一次模型调用需要什么输入,以及程序应当如何处理结果。

01开始之前

了解基本的 HTTP 与 JSON 概念。本课是概念练习,不需要提供 API 密钥,也不会实际发起付费调用。

02跟着做一次

先用自然语言描述应用需求,列出输入、预期输出和失败时的处理方式。具体接口和计费需要在开发时核对官方文档。

一个可以改写的例子
应用任务:把一段会议笔记整理成待办事项。
输入:用户提供的笔记文本。
输出:事项、负责人、截止时间;缺失的信息明确标记为待确认。
失败处理:显示错误并允许重试,不把失败当作空的待办列表。

把示例换成你的真实任务。无需一次写完,先开始,再调整。

03怎么知道自己做对了?

检查输入是否足够,输出结构是否能被应用使用,以及缺失数据和请求失败是否有不同的处理方式。

04现在,轮到你了。

YOUR TURN / 动手练习

为一个你想做的小工具写输入输出约定,并列出两种异常情况。

完成后,花一点时间检查:

示例用于练习表达和核验方法,不代表模型每次都会返回相同结果。正式教程将补充操作截图、适用版本与最后核验时间。
官方参考: Claude 帮助中心 ↗

从一个问题开始