接口文档生成方法及装置、电子设备及可读存储介质.pdf

(19)中华人民共和国国家知识产权局(12)发明专利申请(10)申请公布号CN113626074A(43)申请公布日2021.11.09(21)申请号202110742665.X(22)申请日2021.06.30(71)申请人北京三快在线科技有限公司地址100083北京市海淀区北四环西路9号2106-030(72)发明人江日念牟宗彦武涛(74)专利代理机构北京润泽恒知识产权代理有限公司11319代理人任亚娟(51)Int.Cl.G06F8/73(2018.01)G06F8/71(2018.01)G06F8/41(2018.01)权利要求书2页说明书8页附图3页(54)发明名称接口文档生成方法及装置、电子设备及可读存储介质(57)摘要本发明公开了一种接口文档生成方法及装置、电子设备及可读存储介质。其中，该方法包括：在目标应用程序所处系统环境的环境配置参数与接口文档的环境配置参数匹配的情况下，对目标应用程序中各个对象进行遍历，来确定自定义对象，其中，自定义对象中存在自定义方法，自定义方法为存在自定义注解的方法；对各个自定义方法进行解析，以得到接口文档参数；根据接口文档参数生成目标应用程序对应的接口文档。本发明解决了由于相关技术中Swagger支持的接口单一，需要人工干预才能调用其他接口，而导致接口适配性低、人力资源浪费的技术问题。CN113626074ACN113626074A权利要求书1/2页1.一种接口文档生成方法，其特征在于，包括：目标应用程序所处系统环境的环境配置参数与接口文档的环境配置参数匹配的情况下，对所述目标应用程序中各个对象进行遍历，来确定自定义对象，其中，所述自定义对象中存在自定义方法，所述自定义方法为存在自定义注解的方法；获取与各个自定义对象分别对应的自定义方法；对各个所述自定义方法进行解析，以得到接口文档参数；根据所述接口文档参数生成所述目标应用程序对应的接口文档。2.根据权利要求1所述的方法，其特征在于，获取各个自定义对象分别对应的自定义方法，包括：对所述自定义对象中的自定义方法进行过滤，以得到自定义方法集合。3.根据权利要求2所述的方法，其特征在于，对各个所述自定义方法进行解析，包括：对所述自定义对象以及所述自定义方法的方法名称进行解析，以得到所述接口文档的标题以及调用地址；对所述自定义方法的注解或参数进行解析，以得到所述接口文档的方法描述以及参数描述；根据所述标题、所述调用地址、所述方法描述以及所述参数描述确定所述接口文档参数。4.根据权利要求1所述的方法，其特征在于，在根据所述接口文档参数生成所述目标应用程序对应的接口文档之后，还包括：接收接口调用请求，其中，所述接口调用请求用于请求目标接口的目标接口文档；在所述接口调用请求验证成功的情况下，对所述接口调用请求进行解析，以得到解析结果；对所述解析结果进行反射调用，以得到所述目标接口文档。5.根据权利要求4所述的方法，其特征在于，接收接口调用请求，包括：在预设图形用户界面中展示接口列表；检测作用于所述接口列表的选取操作，根据所述选取操作确定所述目标接口；接收输入的接口参数；根据所述接口参数以及所述目标接口生成所述接口调用请求。6.根据权利要求5所述的方法，其特征在于，所述接口调用请求包括请求路径，其中：在接收接口调用请求之后，还包括：对所述请求路径以及所述接口参数进行验证；在所述请求路径以及所述接口参数验证成功的情况下，确定所述接口调用请求验证成功；否则，确定所述接口调用请求验证失败。7.根据权利要求4所述的方法，其特征在于，在所述接口调用请求验证成功的情况下，对所述接口调用请求进行解析，包括：对所述目标接口对应的对象、方法以及参数进行解析，以得到所述解析结果。8.一种接口文档生成装置，其特征在于，包括：确定单元，用于目标应用程序所处系统环境的环境配置参数与接口文档的环境配置参2CN113626074A权利要求书2/2页数匹配的情况下，对所述目标应用程序中各个对象进行遍历，来确定自定义对象，其中，所述自定义对象中存在自定义方法，所述自定义方法为存在自定义注解的方法；获取单元，用于获取与各个自定义对象分别对应的自定义方法；解析单元，用于对各个所述自定义方法进行解析，以得到接口文档参数；处理单元，用于根据所述接口文档参数生成所述目标应用程序对应的接口文档。9.一种电子设备，其特征在于，包括处理器，存储器及存储在所述存储器上并可在所述处理器上运行的程序或指令，所述程序或指令被所述处理器执行时实现如权利要求1‑7所述的接口文档生成方法的步骤。10.一种可读存储介质，其特征在于，所述可读存储介质上存储程序或指令，所述程序或指令被处理器执行时实现如权利要求1‑7所述的接口文档生成方法的步骤。3CN113626074A说明书1/8页接口文档生成方法及装置、电子设备及可