恭喜腾讯科技(深圳)有限公司凌品获国家专利权
买专利卖专利找龙图腾,真高效! 查专利查商标用IPTOP,全免费!专利年费监控用IP管家,真方便!
龙图腾网恭喜腾讯科技(深圳)有限公司申请的专利接口文档生成方法、装置、计算机设备和存储介质获国家发明授权专利权,本发明授权专利权由国家知识产权局授予,授权公告号为:CN114168190B 。
龙图腾网通过国家知识产权局官网在2025-05-09发布的发明授权授权公告中获悉:该发明授权的专利申请号/专利号为:202010951067.9,技术领域涉及:G06F8/74;该发明授权接口文档生成方法、装置、计算机设备和存储介质是由凌品;余文明设计研发完成,并于2020-09-11向国家知识产权局提交的专利申请。
本接口文档生成方法、装置、计算机设备和存储介质在说明书摘要公布了:本申请涉及一种接口文档生成方法、装置、计算机设备和存储介质。方法包括:获取携带有装饰函数的业务代码,根据装饰函数对应的数据定义规则,提取业务代码中定义的接口参数,根据接口参数,生成接口描述文件,将接口描述文件同步至接口管理平台,由接口管理平台生成接口文档。快速便捷地提取出业务代码中的接口参数,实现了接口参数的自动提取,并借助接口管理平台来实现接口文档的自动生成,实现了接口文档与业务代码的耦合,提高接口文档准确性,准确的接口文档有利于软件开发过程中前后端的高效沟通,从而有效提高软件项目开发效率。
本发明授权接口文档生成方法、装置、计算机设备和存储介质在权利要求书中公布了:1.一种接口文档生成方法,其特征在于,所述方法包括依次执行的本地开发阶段、接口调试阶段以及接口文档生成阶段:在所述本地开发阶段,从开发人员的终端获取携带有装饰函数的业务代码;根据所述装饰函数对应的数据定义规则,提取所述业务代码中定义的接口参数;对所述接口参数进行参数标准化处理,生成接口参数文件;根据预设的文件转换逻辑,将所述接口参数文件转换成符合接口管理平台的格式要求的接口描述文件,所述接口描述文件为具有被接口管理平台识别的特定格式的YAML文件;根据所述接口参数文件,生成接口参数校验文件,所述接口参数校验文件包括jsonschema文件;在所述接口调试阶段,响应node进程重启操作,中断原node进程中加载的文件,将所述jsonschema文件加载至所述node进程,使得在进程中加载的文件是最新的接口参数校验文件;当接收到客户端发起的接口调试请求时,从所述node进程中调用所述jsonschema文件,基于所述jsonschema文件,通过参数验证插件对所述接口调试请求对应的接口参数进行校验,其中,所述接口参数包括输入参数和输出参数;当所述输入参数的校验未通过时,向所述客户端反馈校验失败,并终止校验;当所述输入参数的校验通过,且所述输出参数的校验未通过时,向所述客户端反馈校验失败;在所述接口文档生成阶段,当所述输入参数的校验通过,且所述输出参数的校验通过时,将所述YAML文件同步至接口管理平台,由所述接口管理平台导入所述特定格式的YAML文件,从所述YAML文件中获取接口参数来生成接口文档,或,在检测到存在与所述业务代码对应的初始接口文档时,根据所述YAML更新所述初始接口文档。
如需购买、转让、实施、许可或投资类似专利技术,可联系本专利的申请人或专利权人腾讯科技(深圳)有限公司,其通讯地址为:518000 广东省深圳市南山区高新区科技中一路腾讯大厦35层;或者联系龙图腾网官方客服,联系龙图腾网可拨打电话0551-65771310或微信搜索“龙图腾网”。
1、本报告根据公开、合法渠道获得相关数据和信息,力求客观、公正,但并不保证数据的最终完整性和准确性。
2、报告中的分析和结论仅反映本公司于发布本报告当日的职业理解,仅供参考使用,不能作为本公司承担任何法律责任的依据或者凭证。