接口文档生成方法、装置、计算机设备和存储介质制造方法及图纸

本申请涉及一种接口文档生成方法、装置、计算机设备和存储介质。方法包括：获取携带有装饰函数的业务代码，根据装饰函数对应的数据定义规则，提取业务代码中定义的接口参数，根据接口参数，生成接口描述文件，将接口描述文件同步至接口管理平台，由接口管理平台生成接口文档。快速便捷地提取出业务代码中的接口参数，实现了接口参数的自动提取，并借助接口管理平台来实现接口文档的自动生成，实现了接口文档与业务代码的耦合，提高接口文档准确性，准确的接口文档有利于软件开发过程中前后端的高效沟通，从而有效提高软件项目开发效率。从而有效提高软件项目开发效率。从而有效提高软件项目开发效率。

【技术实现步骤摘要】
接口文档生成方法、装置、计算机设备和存储介质


[0001]本申请涉及计算机
，特别是涉及一种接口文档生成方法、装置、计算机设备和存储介质。

技术介绍

[0002]在软件项目开发过程中，一般采用前后端分离的开发模式进行开发，以提高开发效率，但这种开发模型需要前端开发人员、后端开发人员和测试人员之间的紧密沟通，如前端开发依赖于后端的接口数据，后端开发人员需要提供完善的接口文档给前端开发人员。
[0003]传统技术中，业务代码中的每一个接口均需要通过定义属性、参数等接口说明，并将接口说明写入文档中，得到接口文档，接口文档是独立于业务代码存在的，在业务代码更新后，需要基于更新的业务代码重新定义接口文档没中的各个接口。在将各个接口的接口说明写入或更新至接口文档时，存在接口遗漏或是重复定义的情况，导致接口文档中的信息不够准确，不利于前后端的沟通，从而影响软件项目的开发效率。

技术实现思路

[0004]基于此，有必要针对上述技术问题，提供一种能够提高接口文档准确性以提高软件项目开发效率的接口文档生成方法、装置、计算机设备和存储介本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种接口文档生成方法，其特征在于，所述方法包括：获取携带有装饰函数的业务代码；根据所述装饰函数对应的数据定义规则，提取所述业务代码中定义的接口参数；根据所述接口参数，生成接口描述文件；将所述接口描述文件同步至接口管理平台，由所述接口管理平台生成接口文档。2.根据权利要求1所述的方法，其特征在于，所述根据所述接口参数，生成接口描述文件包括：获取与接口参数文件对应的参数格式规范；根据所述参数格式规范，对所述接口参数进行参数标准化处理，生成接口参数文件；根据预设的文件转换逻辑，将所述接口参数文件转换成接口描述文件。3.根据权利要求2所述的方法，其特征在于，在所述根据所述参数格式规范，对所述接口参数进行参数标准化处理，生成接口参数文件之后，还包括：根据所述接口参数文件，生成接口参数校验文件；当接收到客户端发起的接口调试请求时，根据所述接口参数校验文件，对所述接口调试请求对应的接口参数进行校验；所述将所述接口描述文件同步至接口管理平台，由所述接口管理平台生成接口文档包括：当校验通过时，将所述接口描述文件同步至接口管理平台，由所述接口管理平台生成接口文档。4.根据权利要求3所述的方法，其特征在于，所述接口参数校验文件包括jsonschema文件；所述方法还包括：响应node进程重启操作，将所述jsonschema文件加载至所述node进程；所述当接收到客户端发起的接口调试请求时，根据所述接口参数校验文件，对所述接口调试请求对应的接口参数进行校验包括：当接收到客户端发起的接口调试请求时，从所述node进程中调用jsonschema文件，对所述接口调试请求对应的接口参数进行校验。5.根据权利要求3所述的方法，其特征在于，所述当接收到客户端发起的接口调试请求时，根据所述接口参数校验文件，对所述接口调试请求对应的接口参数进行校验包括：当接收到客户端发起的接口调试请求时，提取所述接口调试请求中...

【专利技术属性】
技术研发人员：凌品，余文明，
申请(专利权)人：腾讯科技深圳有限公司，
类型：发明
国别省市：