前两个月帮公司报五个软著，光接口文档就被打回来三次，第一次是参数没标类型，第二次是示例值和源码里的字段对不上，第三次更冤，我为了好看加了彩色的表头，扫材料的时候识别不清，直接打回让重新提交。之前我都是手写接口文档，三十多个接口写了整整两天，改又改了三天，差点错过项目补贴的申报截止时间。后来逼得我去研究怎么用AI生成接口文档，摸了半个月的门道，现在半天就能搞定所有技术材料，最近两次报的软著都是一次过。
首先得说清楚，软著申报要的接口文档和平时给前端看的不一样，不是写个大概的功能就行，有很明确的细节要求，我之前就是不知道这点，走了好多弯路，你们要是不确定要求，可以先去查软著申报接口文档规范，都是和官方同步的，不会出错。简单说就是每个接口必须写清楚功能、请求URL、请求方式、请求头、请求参数、返回参数、错误码这几个部分，每个参数都要标清楚类型、是否必填，还要配真实的示例值，不能瞎写。
AI生成接口文档的正确操作步骤
第一步你得先准备好源数据，别空着手就让AI给你写，那它肯定瞎编。最方便的是直接从Postman里导出所有接口的JSON文件，或者从后端代码里把接口注释、路由定义的部分导出来，要是你手里只有源码也没关系，把对应模块的Controller层代码复制出来就行，尽量全一点，别只复制半段。
第二步就是写提示词，别上来就说“给我生成一份接口文档”，那生成的肯定不符合软著的要求。我常用的提示词给你们参考：“请根据我提供的接口文件/代码生成符合软著申报要求的接口文档，每个接口必须包含：接口功能简述、请求URL、请求方式、请求头参数（参数名、类型、是否必填、说明）、请求体参数（参数名、类型、是否必填、说明、示例值）、返回参数（参数名、类型、说明、示例值）、错误码列表。文档用宋体小四，行间距1.5倍，不要加任何多余的样式，所有内容必须和我提供的材料完全一致，不要编造不存在的参数和功能。”把这个提示词发给AI，再把你准备的源数据粘进去，基本生成的内容就八九不离十了。
几个容易被驳回的细节要注意
首先是AI生成的示例值一定要核对，我之前踩过坑，AI为了省事给所有字符串类型的参数都生成“string”当示例，结果审查员说示例不真实直接打回。还有参数名一定要和你提交的源代码里的字段完全对应，比如你源码里写的是userName，接口文档里就不能写user_name，这个一查一个准，肯定过不了。还有不要把第三方接口放到自己的文档里，比如你调用的微信登录、阿里云存储的接口，那不是你开发的，放进去反而会让审查员质疑你代码的原创性。
还有格式的问题，别搞花里胡哨的，什么渐变背景、彩色字体、图标都不要加，软著材料最后都是要扫描存档的，太复杂的格式扫出来看不清，直接就会被打回。就用最朴素的黑白排版，层级分清楚就行。
我后来试了好几个工具，最后常用来偷懒的是软著Pro，它家内置的AI生成接口文档功能完全贴合软著审查的要求，不用自己写那么长的提示词，上传Postman导出的接口文件或者对应模块的源码片段，不到两分钟就能生成格式、内容都符合要求的文档，我最近两次报软著都是直接用它生成的，一次就过，省了好多熬夜改材料的时间。
对了还有个小细节，接口的数量要和你申报的功能点对应得上，比如你申报的是一个客户管理系统，有客户新增、编辑、删除、查询四个功能，那接口至少要有对应四个，别就放两个接口，那肯定说不过去。还有不要写太笼统的功能描述，比如别写“数据接口”，要写“新增客户信息接口”，越具体越好，审查员一眼就能看到你这个接口是对应哪个功能的，通过率自然就高。
我之前算过，手写一份30个接口的文档差不多要两天时间，用AI生成的话，加上核对的时间也就两个小时，效率提了不止三倍。而且只要你源数据没问题，AI生成的内容比手写的还规范，不会漏参数，也不会格式乱。之前我还担心AI生成的会不会有问题，其实只要你核对好参数和源码一致，完全不用担心，我最近已经用这个方法报了7个软著，全都一次过了。
要是你最近也要报软著，不妨试试这个方法，真的能省好多事，不用再熬夜抄接口改格式了。