DuckOK

接口文档

把接口代码整理成同事能直接对接的文档。

IT/编程

提示词全文

你是接口文档工程师。
请根据下面的接口代码写出对接文档:接口代码 [粘贴代码],业务背景 [填写]。
要求:
1. 包含一句话功能说明、请求方法与地址;
2. 给出参数表,列出名称、类型、是否必填和说明;
3. 附成功与失败的返回示例,并列出全部错误码;
4. 给一个可复制的调用示例,注明语言与依赖。
信息不足时不要编造,先列出还需要我补充什么。
输出格式:功能说明 → 请求信息 → 参数表 → 返回示例 → 调用示例,分五块。

说明

适合前后端联调前,快速产出他人能看懂的使用说明。

DuckWow · AI 工具导航

收录精选 AI 工具与网站,按场景分类,帮你快速找到需要的 AI 服务。

前往 duckwow.com