免費 软件研发 接口文档 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 的價值是斜線命令隨取隨用。

更多同領域提示詞 · 软件研发