AI生成接口文档学习指南，不会的看过来-CSDN博客

AI生成接口文档视频详解（直接看第11讲）

【2025年新版】DeepSeek教程

文档详细讲解

示例 1 ：

下面是请求`api/focus`这个接口返回的json数据，请帮我根据接口返回的数据写一个接口文档，要求以
表格方式输出
数据：“{
"result": [
{
"_id": "59f6ef443ce1fb0fb02c7a43",
"title": "笔记本电脑",
"status": "1",
"pic": "public\\upload\\UObZahqPYzFvx_C9CQjU8KiX.png",
"url": "12"
},
{
"_id": "5a012efb93ec4d199c18d1b4",
"title": "第二个轮播图",
"status": "1",
"pic": "public\\upload\\f3OtH11ZaPX5AA4Ov95Q7DEM.png"
},
{
"_id": "5a012f2433574208841e0820",
"title": "第三个轮播图",
"status": "1",
"pic": "public\\upload\\s5ujmYBQVRcLuvBHvWFMJHzS.jpg"
},
{
"_id": "5a688a0ca6dcba0ff4861a3d",
"title": "教程",
"status": "1",
"pic": "public\\upload\\Zh8EP9HOasV28ynDSp8TaGwd.png"
}
]
}

接口文档： api/focus

请求方式

Method : GET

返回类型

Content-Type : application/json

响应参数

接口描述

功能：获取轮播图列表数据。

备注：返回的 result 数组中，每个对象代表一个轮播图的数据。 url 字段可能不是所有轮播图记

录都包含，具体取决于后端的数据存储和业务逻辑。

示例响应

{
"result": [
{
"_id": "59f6ef443ce1fb0fb02c7a43",
"title": "笔记本电脑",
"status": "1",
"pic": "public\\upload\\UObZahqPYzFvx_C9CQjU8KiX.png",
"url": "12"
},
{
"_id": "5a012efb93ec4d199c18d1b4",
"title": "第二个轮播图",
"status": "1",
"pic": "public\\upload\\f3OtH11ZaPX5AA4Ov95Q7DEM.png"
},
// ... 其他轮播图数据
]
}

示例2：

下面是请求`api/plist`这个接口返回的json数据，请帮我根据接口返回的数据写一个接口文档，要求以
Markdown表格代码方式输出
内容：
{
"result": [
{
"_id": "5a042c11010e71123466143f",
"title": "兰芝（LANEIGE）小白光气垫BB礼盒",
"cid": "59f1e47e9bfd8f3bd030eed5",
"price": 325,
"old_price": "355",
"pic": "public\\upload\\p4v7HaOPIRrfBCETM7Juv2y9.png",
"s_pic": "public\\upload\\p4v7HaOPIRrfBCETM7Juv2y9.png_200x200.png"
},
{
"_id": "5a042c65010e711234661440",
"title": "暗影精灵III代 15.6英寸游戏笔记本电脑",
"cid": "59f1e4919bfd8f3bd030eed6",
"price": 5999,
"old_price": "8999",
"pic": "public\\upload\\wqdy5XSwZJ8Wkp1FNFM6LGk5.png",
"s_pic": "public\\upload\\wqdy5XSwZJ8Wkp1FNFM6LGk5.png_200x200.png"
},
{
"_id": "5a042682010e71123466143b",
"title": "2V341DD7低靴皮带扣细跟中跟鞋",
"cid": "5a04261e010e71123466143a",
"price": 188,
"old_price": "288",
"pic": "public\\upload\\cPvPwUACxcco6PYXWwhSrkPN.png",
"s_pic": "public\\upload\\cPvPwUACxcco6PYXWwhSrkPN.png_200x200.png"
}
]
}

接口文档： api/plist

请求方式

Method : GET （假设为 GET 请求，根据实际情况可能有所不同）

返回类型

Content-Type : application/json

响应参数

接口描述

功能：获取商品列表数据。

备注：返回的 result 数组中，每个对象代表一个商品的数据。 old_price 和 s_pic 字段可能不

是所有商品记录都包含，具体取决于后端的数据存储和业务逻辑。

示例响应

{
"result": [
{
"_id": "5a042c11010e71123466143f",
"title": "兰芝（LANEIGE）小白光气垫BB礼盒",
"cid": "59f1e47e9bfd8f3bd030eed5",
"price": 325,
"old_price": "355",
"pic": "public\\upload\\p4v7HaOPIRrfBCETM7Juv2y9.png",
"s_pic": "public\\upload\\p4v7HaOPIRrfBCETM7Juv2y9.png_200x200.png"
},
// ... 其他商品数据
]
}