接口文档同步方法、装置、电子设备及存储介质.pdf

(19)中华人民共和国国家知识产权局(12)发明专利申请(10)申请公布号CN114201213A(43)申请公布日2022.03.18(21)申请号202111537760.2(22)申请日2021.12.15(71)申请人北京达佳互联信息技术有限公司地址100085北京市海淀区上地西路6号1幢1层101D1-7(72)发明人吕灿锋(74)专利代理机构华进联合专利商标代理有限公司44224代理人黄丽霞(51)Int.Cl.G06F8/71(2018.01)G06F8/73(2018.01)权利要求书2页说明书13页附图5页(54)发明名称接口文档同步方法、装置、电子设备及存储介质(57)摘要本公开关于一种接口文档同步方法、装置、电子设备及存储介质。所述方法包括：接收接口文档同步接口被访问时传入的接口同步参数，并确定所述接口同步参数中的接口标识；根据预加载的文档同步配置信息，确定针对所述接口标识对应接口类型的文档扫描目录；读取在所述文档扫描目录中与所述接口标识对应接口的接口文档；其中，所述接口文档为根据所述接口的接口注解信息生成的；所述接口注解信息为读取所述接口的接口代码确定的；将所述接口文档同步至接口管理平台；所述接口管理平台用于向用户账户呈现所述接口文档。采用本公开可以提高软件项目开发的效率。CN114201213ACN114201213A权利要求书1/2页1.一种接口文档同步方法，其特征在于，包括：接收接口文档同步接口被访问时传入的接口同步参数，并确定所述接口同步参数中的接口标识；根据预加载的文档同步配置信息，确定针对所述接口标识对应接口类型的文档扫描目录；读取在所述文档扫描目录中与所述接口标识对应接口的接口文档；其中，所述接口文档为根据所述接口的接口注解信息生成的；所述接口注解信息为读取所述接口的接口代码确定的；将所述接口文档同步至接口管理平台；所述接口管理平台用于向用户账户呈现所述接口文档。2.根据权利要求1所述的接口文档同步方法，其特征在于，所述将所述接口文档同步至接口管理平台，包括：获取针对所述接口文档的目标同步目录；所述目标同步目录为所述接口管理平台中用于存放所述接口文档的文件目录；基于所述目标同步目录和所述接口文档，生成文档同步指令；发送所述文档同步指令至所述接口管理平台的接口文档导入接口；所述接口文档导入接口用于响应所述文档同步指令，将所述接口文档导入至所述目标同步目录中。3.根据权利要求2所述的接口文档同步方法，其特征在于，所述获取针对所述接口文档的目标同步目录，包括：读取所述接口的接口代码，确定所述接口的同步目录注解信息；解析所述同步目录注解信息，确定针对所述接口文档的子级同步目录，以及，解析所述文档同步配置信息，确定针对所述接口文档的父级同步目录；根据所述父级同步目录和所述子级同步目录，构建所述目标同步目录。4.根据权利要求2所述的接口文档同步方法，其特征在于，在所述发送所述文档同步指令至所述接口管理平台的接口文档导入接口的步骤之后，所述方法还包括：接收所述接口文档导入接口返回的文档导入结果；解析所述文档导入结果，确定已导入所述接口管理平台的接口文档的数量信息。5.根据权利要求1至4任一所述的接口文档同步方法，其特征在于，所述方法还包括：加载所述文档同步配置信息，对预设的接口文档生成程序进行初始化，得到初始化后的接口文档生成程序；其中，所述初始化后的接口文档生成程序用于读取所述接口的接口代码，确定所述接口的接口注解信息，并根据所述接口注解信息，生成具有预设格式的接口描述文件；还用于将所述接口描述文件作为所述接口对应的接口文档保存至所述文档扫描目录中。6.根据权利要求5所述的接口文档同步方法，其特征在于，所述加载所述文档同步配置信息，对预设的接口文档生成程序进行初始化，得到初始化后的接口文档生成程序，包括：获取当前业务环境；若所述当前业务环境满足预设业务环境，则执行所述加载所述文档同步配置信息，对预设的接口文档生成程序进行初始化，得到初始化后的接口文档生成程序的步骤；其中，所述预设业务环境包括业务测试环境和业务开发环境中的至少一种。2CN114201213A权利要求书2/2页7.一种接口文档同步装置，其特征在于，包括：接收单元，被配置为执行接收接口文档同步接口被访问时传入的接口同步参数，并确定所述接口同步参数中的接口标识；确定单元，被配置为执行根据预加载的文档同步配置信息，确定针对所述接口标识对应接口类型的文档扫描目录；读取单元，被配置为执行读取在所述文档扫描目录中与所述接口标识对应接口的接口文档；其中，所述接口文档为根据所述接口的接口注解信息生成的；所述接口注解信息为读取所述接口的接口代码确定的；同步单元，被配置为执行将所述接口文档同步至接口管理平台；所述接口管理平台用于向用户账户呈现所述接口文档。8