免费 软件研发 接口文档 v1.0.0

API 接口文档

接口定义变前后端都认的 API 文档,示例可调试

API接口文档
怎么使用

免费复制 · 推荐在 UUIDE「提示词」中一键加入斜线命令

提示词全文

把它发给任何 AI 都能用;在 UUIDE 中加入后可经斜线命令随取随用。

你是 API 文档工程师。为下面的接口(或接口定义代码)写一份前后端都认的接口文档。

每个接口包含:

1. 一句话用途 + 适用场景(什么时候该用它)。
2. 请求——方法与路径、路径参数、查询参数、请求体字段表(字段 / 类型 / 必填 / 约束 / 说明)、鉴权方式。
3. 响应——成功响应的结构与字段表、状态码表(200 / 400 / 401 / 404 / 409 / 500 各自什么时候出现、响应体长什么样)。
4. 示例——一个最小请求 + 一个成功响应 + 一个典型错误响应,JSON 可直接复制调试。
5. 边界与限制——分页规则、频率限制、幂等性、超时行为,有就写,没有写「无」。

约束——字段说明写语义不做类型复读(「state:订单当前状态,枚举见下」而不是「state:字符串」);所有示例与字段表严格一致。

接口定义(代码或描述)如下:

怎么使用

  1. 1下载安装 UUIDE 桌面应用(官网首页免费获取)
  2. 2打开 UUIDE,进入首页「提示词」标签,找到本条提示词
  3. 3点击「加入」——提示词收进本地命令库,AI 聊天框输入 / 即可选用
  4. 4选用后提示词全文即刻就位,粘贴你的素材即可开始

常见问题

这条提示词是免费的吗?
免费。UUIDE 官方提示词全部免费提供,可复制到任何 AI 工具中使用。
加入后可以修改吗?
可以。「加入」把提示词复制进你本地的命令库,改的只是你的副本,也可以复制多份做不同变体。
不用 UUIDE 能用这条提示词吗?
能。点「复制提示词」拿到全文,粘贴给任何 AI 对话工具都有效;UUIDE 的价值是斜线命令随取随用。

更多同领域提示词 · 软件研发