如何根据提供的文档起草 API 示例
API 示例帮助读者将端点描述与具体的请求和响应结构联系起来。准确性取决于实际提供的方法、字段和认证要求。
从合适的材料开始。
- 你需要提供什么
- 一个显示方法、路径和 Schema 的 API 参考页面。
- 预期结果
- 使用占位凭据和文档中列明的字段保存请求示例。
工作流程如何运作。
使用文档中的结构和明显虚构的示例值。保留必填与可选字段的区别，用占位符表示凭据，不要包含真实密钥。
结果中需要检查的内容。
在相关环境验证示例后，才能将其作为已测试内容发布。看似合理的请求或响应不能证明端点存在，也不能证明其行为如示例所示。
将文本视为可编辑结果，并与来源核对。复制到其他文档或消息时，保留重要引用、姓名和条件。
参考完整示例学习。
使用可下载示例了解结果形式。与来源示例对照，再对你为自己的任务提供的材料执行相同的事实核查。
所提供的示例仅用于说明，并非针对你的数据执行的记录。
下载示例 ↓用于你自己的材料。
- 打开要处理的来源，并在该标签页中启用 WebAct。
- 复制页面顶部的任务，补充必需的字段或偏好，并检查建议执行的操作。
- 将首次结果与来源对照，必要时提出具体修改或完善要求。