MiniMax Code可自动将Swagger/Postman/文字描述类API源生成结构化中文文档,需确保输入含URL、方法、关键参数三项,命名api_source.json,用指定Prompt触发五部分文档生成,并严格校验必填项、示例值和curl方法一致性。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要把一段API接口描述(比如Swagger JSON、Postman集合导出的JSON,或一段带参数说明的中文需求)喂给MiniMax Code,让它自动整理成结构清晰、字段完整、含示例请求/响应的正式接口文档,而不是手动逐条抄写或拼凑Markdown。
准备原始接口材料
先确认你手头的输入源是哪一类:如果是Swagger 2.0或OpenAPI 3.x规范的JSON文件,直接保存为openapi.json;如果是Postman导出的Collection v2.1,确保导出格式选的是JSON(v2.1);如果只有文字描述,必须包含至少三项:接口URL、HTTP方法、关键请求参数(名称、类型、是否必填、示例值)。
没有这三项信息,MiniMax Code生成的文档会缺失核心字段,后续开发联调时容易因参数理解偏差导致400错误。
把文件放到项目根目录下,命名为api_source.json——这个固定命名能避免后续Prompt里反复指定路径,减少模型误读概率。
构造精准提示词(Prompt)
打开MiniMax Code对话界面,粘贴以下提示词(不修改任何占位符):
请根据提供的api_source.json内容,生成符合国内后端团队阅读习惯的中文接口文档。要求:① 按「接口概览→请求说明→请求参数→响应参数→示例」五部分组织;② 请求参数表格必须包含【字段名】【类型】【是否必填】【说明】【示例值】五列;③ 响应参数若含嵌套对象,需用缩进+破折号展开至二级字段;④ 最后给出一个完整的curl命令示例,Header中Authorization值写为Bearer YOUR_API_KEY,URL和body按实际填充。
使用APIDot进行MiniMax Music 2.6 API工作流程,包括AI音乐生成、歌词创作、器乐制作、音频导出规划、异步任务提交、任务ID...
这一步不能省略“国内后端团队阅读习惯”这个限定——MiniMax M2.7模型在训练时对国内技术文档语序(如“必填”前置、“示例值”单独成列)有强偏好,漏掉会导致表格列顺序错乱,比如把“说明”挤到最后一列。
执行生成并校验关键字段
点击发送后等待3~8秒,生成结果会以Markdown块形式返回。
立刻检查三个不可逆位置:【是否必填】列是否存在空值、【示例值】是否全部为真实可运行的字符串/数字(而非null或example_string)、curl命令中的-X POST是否与接口实际方法一致(如GET接口误写成POST会误导前端)。
发现任意一项异常,必须重新生成——MiniMax Code不会自动修正已输出的错误字段,二次编辑只会污染文档结构。
确认无误后,全选生成内容→复制→新建API_DOC.md文件→粘贴保存。

















