[发明专利]一种接口文档处理方法、装置、电子设备以及存储介质在审
申请号: | 202011025704.6 | 申请日: | 2020-09-25 |
公开(公告)号: | CN112015468A | 公开(公告)日: | 2020-12-01 |
发明(设计)人: | 陈佳熠 | 申请(专利权)人: | 北京百度网讯科技有限公司 |
主分类号: | G06F8/73 | 分类号: | G06F8/73;G06F8/38;G06F8/34;G06F11/36 |
代理公司: | 北京品源专利代理有限公司 11332 | 代理人: | 孟金喆 |
地址: | 100085 北京市*** | 国省代码: | 北京;11 |
权利要求书: | 查看更多 | 说明书: | 查看更多 |
摘要: | |||
搜索关键词: | 一种 接口 文档 处理 方法 装置 电子设备 以及 存储 介质 | ||
1.一种接口文档处理方法,包括:
根据应用程序接口提供方提供的服务请求示例和所述服务请求示例关联的参数列表,确定所述服务请求示例中请求参数的目标描述信息;
根据所述请求参数的目标描述信息,生成应用程序接口文档中参数调用说明内容。
2.根据权利要求1所述的方法,其中,根据应用程序接口提供方提供的服务请求示例和所述服务请求示例关联的参数列表,确定所述服务请求示例中请求参数的目标描述信息,包括:
对所述服务请求示例进行解析,得到所述服务请求示例中请求参数的基础描述信息;所述基础描述信息包括参数名称和参数类型;
根据所述请求参数的基础描述信息和所述服务请求示例关联的参数列表,得到所述请求参数的目标描述信息。
3.根据权利要求1所述的方法,其中,根据应用程序接口提供方提供的服务请求示例和所述服务请求示例关联的参数列表,确定所述服务请求示例中请求参数的目标描述信息,包括:
将所述服务请求示例中参数名称相同且参数值不同的请求参数,作为重复请求参数;
根据所述重复请求参数在所述服务请求示例中的位置信息和所述服务请求示例关联的参数列表,构建所述重复请求参数关联的参数详情队列;
根据所述服务请求示例、所述服务请求示例关联的参数列表和所述参数详情队列,确定所述服务请求示例中请求参数的目标描述信息。
4.根据权利要求2所述的方法,其中,根据所述请求参数的基础描述信息和所述服务请求示例关联的参数列表,得到所述请求参数的目标描述信息,包括:
根据所述请求参数的基础描述信息中的参数名称,从所述服务请求示例关联的参数列表中进行匹配;
根据匹配结果,对所述请求参数的基础描述信息进行扩展,得到所述请求参数的目标描述信息。
5.根据权利要求2所述的方法,其中,所述服务请求示例采用Json数据结构编写;所述目标描述信息和所述基础描述信息采用Json Schema数据结构编写。
6.一种接口文档处理装置,包括:
目标信息确定模块,用于根据应用程序接口提供方提供的服务请求示例和所述服务请求示例关联的参数列表,确定所述服务请求示例中请求参数的目标描述信息;
内容生成模块,用于根据所述请求参数的目标描述信息,生成应用程序接口文档中参数调用说明内容。
7.根据权利要求6所述的装置,其中,所述目标信息确定模块包括:
基础信息确定单元,用于对所述服务请求示例进行解析,得到所述服务请求示例中请求参数的基础描述信息;所述基础描述信息包括参数名称和参数类型;
目标信息确定单元,用于根据所述请求参数的基础描述信息和所述服务请求示例关联的参数列表,得到所述请求参数的目标描述信息。
8.根据权利要求6所述的装置,其中,所述目标信息确定模块具体用于:
将所述服务请求示例中参数名称相同且参数值不同的请求参数,作为重复请求参数;
根据所述重复请求参数在所述服务请求示例中的位置信息和所述服务请求示例关联的参数列表,构建所述重复请求参数关联的参数详情队列;
根据所述服务请求示例、所述服务请求示例关联的参数列表和所述参数详情队列,确定所述服务请求示例中请求参数的目标描述信息。
9.根据权利要求7所述的装置,其中,所述目标信息确定单元具体用于:
根据所述请求参数的基础描述信息中的参数名称,从所述服务请求示例关联的参数列表中进行匹配;
根据匹配结果,对所述请求参数的基础描述信息进行扩展,得到所述请求参数的目标描述信息。
10.根据权利要求7所述的装置,其中,所述服务请求示例采用Json数据结构编写;所述目标描述信息和所述基础描述信息采用Json Schema数据结构编写。
该专利技术资料仅供研究查看技术是否侵权等信息,商用须获得专利权人授权。该专利全部权利属于北京百度网讯科技有限公司,未经北京百度网讯科技有限公司许可,擅自商用是侵权行为。如果您想购买此专利、获得商业授权和技术合作,请联系【客服】
本文链接:http://www.vipzhuanli.com/pat/books/202011025704.6/1.html,转载请声明来源钻瓜专利网。
- 上一篇:一种空调试验用冷凝排热装置
- 下一篇:一种横向磁通电机