对于接口文档的编写， 我觉得用任何工具都会有极大的效率耗损。包括 yapi ，postman ，还有注释类的 swagger 。
接口文档特别是内部用的并且是前端用的，95%的情况就是一个简单的输出与输入，主要工作是描述清楚字段结构，主要目的是与前端达成沟通以及存档的作用，并不需要多么标准化。
而各种工具，无论是界面类的还是注释自动转换类的， 都需要遵照特定规范，按要求去填写。
点击一个输入框或是写上特定标记注释都需要额外消耗，这些精准规范其实没必要。
所以我认为在写文档的效率方面， 直接用最简单的文本是最方便的，直接在代码编辑器方法的注释上上这段文本，不需要遵照特定注释规范，无需担心格式出错。特别是输出参数比较多， 层级也多，直接用所见即所得的 json 文本本身做为描述是最简单的。
然后把我们写得不那么标准的简化注释用 ChatGPT 转换成勉强标准的结构化文档，这样就很好，它就适合做这类不精准的东西，还有纠错能力。
我试过了，它转换成的 postman 导入文件居然是对的，我还担心这种事情它一般会出错，不过凡涉及代码的东西最好不用，有时出错给它排错的时间不值。
[Imgur](
)