让 Vecbase Agent 完成 API 文档

根据实现说明资源、认证、请求、响应、错误、分页、限制、幂等、Webhook、示例和版本。Agent 会整理成开发者可以直接使用的准确 API 文档,并把关键依据和待确认问题清楚留给你复核。

Vecbase 1.0 Lite
  1. 1添加代码
  2. 2输入要求
  3. 3提交

三步完成

  1. 1

    添加真实背景

    提供代码、结构定义、需求或示例,说明使用对象、要支持的决策、限制条件和完成标准。

  2. 2

    让 Agent 完成 API 文档

    根据实现说明资源、认证、请求、响应、错误、分页、限制、幂等、Webhook、示例和版本。

  3. 3

    复核并继续修改

    复核开发者可以直接使用的准确 API 文档,确认标出的问题,并在同一段对话中继续修改。

为什么结果更容易使用

理解并完成整个任务

根据实现说明资源、认证、请求、响应、错误、分页、限制、幂等、Webhook、示例和版本。

关键依据便于复核

示例和结构会对照源码或真实行为核查,不会编造不存在的端点。

不止生成第一版

可以在同一段对话中继续调整开发者可以直接使用的准确 API 文档的范围、重点、格式和细节。

开始前常见问题

完成 API 文档需要提供什么?

先提供代码、结构定义、需求或示例,再补充使用对象、要支持的决策、限制、偏好格式和必须保持不变的内容。

Agent 会怎样完成 API 文档?

根据实现说明资源、认证、请求、响应、错误、分页、限制、幂等、Webhook、示例和版本。

我怎样核对结果?

示例和结构会对照源码或真实行为核查,不会编造不存在的端点。

第一版完成后还能继续修改吗?

可以。你可以在同一段对话中继续修改开发者可以直接使用的准确 API 文档、补充待确认信息,或更换使用对象和格式。

Vecbase

现在开始:API 文档

任务:API 文档。请先添加所需材料(代码、结构定义、需求或示例),并说明重点。Vecbase Agent 会根据要求整理出开发者可以直接使用的准确 API 文档,你可以继续复核和修改。