【技术实现步骤摘要】
一种接口文档构建方法、装置、电子设备及存储介质
[0001]本专利技术涉及计算机
，具体涉及一种接口文档构建方法、装置、电子设备及存储介质。
技术介绍
[0002]在开发API(Application Programming Interface，应用程序接口)接口时，需要对应编写一个用来描述接口的请求参数和返回结果的接口文档，以便于后期调用接口使用。
[0003]目前，开发人员编写代码实现API接口的同时，还需要花费时间和精力编写对应的接口文档。通常一个工程项目中一个功能模块会涉及到多个API接口，如果每个API接口均由人工手动编写，会延长软件开发周期，并且如果某一API 接口的代码发生修改，还需要维护相应的接口文档，维护成本也高。
技术实现思路
[0004]本专利技术的目的是针对上述现有技术的不足提出的一种接口文档构建方法、装置、电子设备及存储介质，该目的是通过以下技术方案实现的。
[0005]本专利技术的第一方面提出了一种接口文档构建方法，所述方法应用于后台服务器，所述方法包括：
【技术保护点】
【技术特征摘要】
1.一种接口文档构建方法，其特征在于，所述方法应用于后台服务器，所述方法包括：接收代码管理服务器发送的代码提交通知；从所述代码管理服务器中，提取所述代码提交通知携带的工程项目标识对应的各个模块所包含的接口代码文件；针对每个模块，根据所述模块包含的接口代码文件中的代码注释块构建所述模块的第一接口文档。2.根据权利要求1所述的方法，其特征在于，所述根据所述模块包含的接口代码文件中的代码注释块构建所述模块的第一接口文档，包括：针对所述模块包含的每一接口代码文件，从所述接口代码文件中提取代码注释块；根据提取的每个代码注释块中的分组参数，对分组参数相同的代码注释块进行组合处理；基于组合后的代码注释块和未组合的代码注释块，构建所述模块的第一接口文档。3.根据权利要求2所述的方法，其特征在于，在基于组合后的代码注释块和未组合的代码注释块，构建所述模块的第一接口文档之后，所述方法还包括：将所述模块的第一接口文档转换为预设格式的文件；在接收到针对所述文件的查看请求时，读取并解析所述文件，以在WEB页面中显示所述文件中的内容。4.根据权利要求1所述的方法，其特征在于，在针对每个模块，根据所述模块包含的接口代码文件中的代码注释块构建所述模块的第一接口文档之后，所述方法还包括：接收代码管理服务器发送的代码更新通知；从所述代码管理服务器中，读取所述代码更新通知携带的模块标识所对应的接口代码文件；根据读取的接口代码文件中的代码注释块构建所述模块标识对应的第二接口文档，并用所述第二接口文档替换所述模块标识对应的第一接口文档。5.一种接口文档构建方法，其特征在于，所述方法应用于代码管理服务器，所述方法包括：接收前端设备提交的工程项目下各个模块包含的接口代码文件；对每个接口代码文件中的代码注释块进行语法检测；如果均检测通过，则向后台服务器发送代码提交通知，以使所述后台服务器基于所述代码提交通知读取各个模块包含的接口代码文件，并构建各个模块的接口文档；如果有检测未通过的代码注释块，则向所述前端设备提示检测未通过代码注释块所属的接口代码文件。6.根据权利要求5所述的方...
【专利技术属性】
技术研发人员：王雪，卢旭，
申请(专利权)人：北京新氧万维科技咨询有限公司，
类型：发明
国别省市：
还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。