接口文档生成方法、装置、计算机设备和存储介质.pdf

(19)中华人民共和国国家知识产权局(12)发明专利申请(10)申请公布号CN114168190A(43)申请公布日2022.03.11(21)申请号202010951067.9(22)申请日2020.09.11(71)申请人腾讯科技（深圳）有限公司地址518000广东省深圳市南山区高新区科技中一路腾讯大厦35层(72)发明人凌品余文明(74)专利代理机构华进联合专利商标代理有限公司44224代理人李文渊(51)Int.Cl.G06F8/74(2018.01)G06F8/73(2018.01)权利要求书2页说明书10页附图9页(54)发明名称接口文档生成方法、装置、计算机设备和存储介质(57)摘要本申请涉及一种接口文档生成方法、装置、计算机设备和存储介质。方法包括：获取携带有装饰函数的业务代码，根据装饰函数对应的数据定义规则，提取业务代码中定义的接口参数，根据接口参数，生成接口描述文件，将接口描述文件同步至接口管理平台，由接口管理平台生成接口文档。快速便捷地提取出业务代码中的接口参数，实现了接口参数的自动提取，并借助接口管理平台来实现接口文档的自动生成，实现了接口文档与业务代码的耦合，提高接口文档准确性，准确的接口文档有利于软件开发过程中前后端的高效沟通，从而有效提高软件项目开发效率。CN114168190ACN114168190A权利要求书1/2页1.一种接口文档生成方法，其特征在于，所述方法包括：获取携带有装饰函数的业务代码；根据所述装饰函数对应的数据定义规则，提取所述业务代码中定义的接口参数；根据所述接口参数，生成接口描述文件；将所述接口描述文件同步至接口管理平台，由所述接口管理平台生成接口文档。2.根据权利要求1所述的方法，其特征在于，所述根据所述接口参数，生成接口描述文件包括：获取与接口参数文件对应的参数格式规范；根据所述参数格式规范，对所述接口参数进行参数标准化处理，生成接口参数文件；根据预设的文件转换逻辑，将所述接口参数文件转换成接口描述文件。3.根据权利要求2所述的方法，其特征在于，在所述根据所述参数格式规范，对所述接口参数进行参数标准化处理，生成接口参数文件之后，还包括：根据所述接口参数文件，生成接口参数校验文件；当接收到客户端发起的接口调试请求时，根据所述接口参数校验文件，对所述接口调试请求对应的接口参数进行校验；所述将所述接口描述文件同步至接口管理平台，由所述接口管理平台生成接口文档包括：当校验通过时，将所述接口描述文件同步至接口管理平台，由所述接口管理平台生成接口文档。4.根据权利要求3所述的方法，其特征在于，所述接口参数校验文件包括jsonschema文件；所述方法还包括：响应node进程重启操作，将所述jsonschema文件加载至所述node进程；所述当接收到客户端发起的接口调试请求时，根据所述接口参数校验文件，对所述接口调试请求对应的接口参数进行校验包括：当接收到客户端发起的接口调试请求时，从所述node进程中调用jsonschema文件，对所述接口调试请求对应的接口参数进行校验。5.根据权利要求3所述的方法，其特征在于，所述当接收到客户端发起的接口调试请求时，根据所述接口参数校验文件，对所述接口调试请求对应的接口参数进行校验包括：当接收到客户端发起的接口调试请求时，提取所述接口调试请求中的输入参数；根据所述接口参数校验文件中的输入参数定义规范，对所述输入参数进行校验；当所述输入参数校验通过时，根据业务代码中的业务逻辑，得到所述输入参数对应的输出参数；根据所述接口参数校验文件中的输出参数定义规范，对所述输出参数进行校验；所述当校验通过时，将所述接口描述文件同步至接口管理平台，由所述接口管理平台生成接口文档包括：当所述输出参数校验通过时，将所述接口描述文件同步至接口管理平台，由所述接口管理平台生成接口文档。6.根据权利要求3所述的方法，其特征在于，在所述当接收到客户端发起的接口调试请2CN114168190A权利要求书2/2页求时，根据所述接口参数校验文件，对所述接口调试请求对应的接口参数进行校验之后，还包括：当所述接口参数校验失败时，反馈接口参数非法信息至所述客户端，以使所述客户端根据所述接口参数非法信息，更新所述业务代码。7.根据权利要求1所述的方法，其特征在于，所述方法还包括：向所述接口管理平台发送接口信息查看请求；接收所述接口管理平台反馈的接口信息，并将所述接口信息推送至接口信息展示界面，所述接口信息包括接口基本信息、请求参数信息以及返回数据信息。8.一种接口文档生成装置，其特征在于，所述装置包括：业务代码获取模块，用于获取携带有装饰函数的业务代码；接口参数提取模块，用于根据所述装饰函数对应的数据定义规则，提取所述业务代码中定义的接口参数；接口描述文件生成模块，用于根据所述接口参数，生成接