基于API文档的API接口开发管理方法及系统.pdf

《基于API文档的API接口开发管理方法及系统.pdf》由会员分享，可在线阅读，更多相关《基于API文档的API接口开发管理方法及系统.pdf（8页珍藏版）》请在专利查询网上搜索。

1、(19)中华人民共和国国家知识产权局 (12)发明专利申请 (10)申请公布号 (43)申请公布日 (21)申请号 202010188636.9 (22)申请日 2020.03.17 (71)申请人 四川研宝科技有限公司 地址 611731 四川省成都市高新区 （西区） 新航路2号 (72)发明人 王庆李帆王丽杨力军 (74)专利代理机构 四川力久律师事务所 51221 代理人 韩洋 (51)Int.Cl. G06F 8/34(2018.01) G06F 8/41(2018.01) G06F 8/60(2018.01) G06F 8/73(2018.01) (54)发明名称 一种基于API文档。

2、的API接口开发管理方法 及系统 (57)摘要 本发明涉及计算机技术领域， 并公开了一种 基于API文档的API接口开发管理方法及系统， 包 括： 网关系统接收用户编写的API文档， 并判断所 述API文档是否符合编写标准， 若是， 则对所述 API文档进行解析并存储所述API文档的解析结 果， 并将所述API文档发布给开发端， 若否， 则标 记为无效文档； 待接收到开发端的API接口开发 结果后， 网关系统根据存储的API文档的解析结 果对所述API接口开发结果进行检验， 若检验合 格， 则发布相应的API接口； 若不合格， 则发送提 示信息给开发端。 本发明通过网关系统管理API 文档、 。

3、检验API开发结果并发布的方式实现对API 接口的自动部署， 减少软件项目开发的难度。 权利要求书1页 说明书4页 附图2页 CN 111399825 A 2020.07.10 CN 111399825 A 1.一种基于API文档的API接口开发管理方法， 其特征在于， 包括： 网关系统接收用户编写的API文档， 并判断所述API文档是否符合编写标准， 若是， 则对 所述API文档进行解析并存储所述API文档的解析结果， 并将所述API文档发布给开发端， 若 否， 则标记为无效文档； 待接收到开发端的API接口开发结果后， 网关系统根据存储的API文档的解析结果对所 述API接口开发结果进行检。

4、验， 若检验合格， 则发布相应的API接口； 若不合格， 则发送提示 信息给开发端。 2.如权利要求1所述的方法， 其特征在于， 所述API文档的编写标准为OpenAPI标准， 且 以yml文档存储所述API文档的各个模块。 3.如权利要求1所述的方法， 其特征在于， 采用Gitlab Runner将所述API文档编译成基 于SwaggerEditor的Web可视化内容发布给开发端。 4.如权利要求3所述的方法， 其特征在于， 当用户更新其编写的API文档且用户更新的 API文档符合所述编写标准时， 对所述Web可视化内容进行实时更新。 5.如权利要求1所述的方法， 其特征在于， 所述API文。

5、档的解析结果至少包括用户请求 的多个API接口类型、 接口功能以及接口访问权限。 6.如权利要求5所述的方法， 其特征在于， 根据所述API文档的解析结果对所述API接口 开发结果进行检验， 包括： 步骤601， 网关系统判断所述API接口开发结果是否涵盖了用户请求的所有API接口类 型， 若是， 则进入步骤602； 若否， 即有遗漏的API接口类型， 则发送接口类型错误的提示信息 给开发端； 步骤602， 网关系统判断所述API接口开发结果是否存在用户未请求的API接口类型， 若 是， 则标记为无效API接口， 并删除所述无效API接口； 若否， 则进入步骤603； 步骤603， 通过Swa。

6、gger Editor进行所述API接口开发结果的接口功能测试， 测试其能 否实现用户请求的接口功能， 若能， 则为有效的API接口开发结果， 网关系统根据用户请求 的接口访问权限对所述API接口开发结果进行权限设置并发布相应的API接口； 若否， 则发 送接口功能错误的提示信息给开发端。 7.一种网关系统， 其特征在于， 包括： 判断模块， 用于接收并判断用户编写的API文档是否符合编写标准， 若是则将所述API 文档发送至解析模块和发布模块； 若否， 则标记为无效文档； 发布模块， 用于接收所述API文档， 并将所述API文档发布给开发端； 解析模块， 用于接收所述API文档， 并对所述A。

7、PI文档进行解析并存储所述API文档的解 析结果； 验证模块， 用于接收开发端的API接口开发结果， 并读取所述解析模块中存储的API文 档的解析结果对所述API接口开发结果进行检验； 若检验合格， 则发布相应的API接口； 若不 合格， 则发送提示信息给开发端。 8.一种可读存储介质， 其上存储有一个或多个程序， 其特征在于， 该一个或多个程序被 一个或多个处理器执行时实现权利要求16任一项所述的基于API文档的API接口开发管 理方法。 权利要求书 1/1 页 2 CN 111399825 A 2 一种基于API文档的API接口开发管理方法及系统 技术领域 0001 本发明涉及计算机技术领。

8、域， 特别涉及一种基于API文档的API接口开发管理方法 及系统。 背景技术 0002 随着web技术的发展， 前后端分离成为越来越多互联网公司构建应用的方式。 前后 端分离的优势是一套API可被多个客户端复用， 分工和协作被细化， 大大提高了编码效率， 但是由于前后端分离， 后端的开发结果往往不可靠， 容易遗漏前端的接口需求或者给前端 一些错误的API接口， 这种错误则需要前端用户在使用后端的开发结果后才能被发现， 缺乏 一个有效性的检验。 并且由于API是一些预先定义的函数， 一旦前端用户需求变化， 则需要 花费精力频繁修改和更新API接口文档， 后端用户也无法及时获知前端需求的更新， 容。

9、易造 成后端开发的不停修改、 返工， 致使相应的软件接口开发过程错误率高、 效率低下。 因此， 为 了进一步提升开发软件项目的效率， 急需一种有效的API文挡的API接口开发管理方法及系 统， 以解决API接口开发结果不可靠及文档更新不及时的问题。 发明内容 0003 本发明的目的在于克服现有技术中的上述不足， 提供一种基于API文档的API接口 开发管理方法及系统。 0004 为了实现上述目的， 本发明提供了以下技术方案： 0005 一种基于API文档的API接口开发管理方法， 包括： 0006 网关系统接收用户编写的API文档， 并判断所述API文档是否符合编写标准， 若是， 则对所述AP。

10、I文档进行解析并存储所述API文档的解析结果， 并将所述API文档发布给开发 端， 若否， 则标记为无效文档； 0007 待接收到开发端的API接口开发结果后， 网关系统根据存储的API文档的解析结果 对所述API接口开发结果进行检验， 若检验合格， 则发布相应的API接口； 若不合格， 则发送 提示信息给开发端。 0008 优选的， 所述API文档的编写标准为OpenAPI标准， 且以yml文档存储所述API文档 的各个模块。 0009 优选的， 采用Gitlab Runner将所述API文档编译成基于Swagger Editor的Web可 视化内容发布给开发端。 0010 优选的， 当用户。

11、更新其编写的API文档且用户更新的API文档符合所述编写标准 时， 对所述Web可视化内容进行实时更新。 0011 优选的， 所述API文档的解析结果至少包括用户请求的多个API接口类型、 接口功 能以及接口访问权限。 0012 优选的， 根据所述API文档的解析结果对所述API接口开发结果进行检验， 包括： 0013 步骤601， 网关系统判断所述API接口开发结果是否涵盖了用户请求的所有API接 说明书 1/4 页 3 CN 111399825 A 3 口类型， 若是， 则进入步骤602； 若否， 即有遗漏的API接口类型， 则发送接口类型错误的提示 信息给开发端； 0014 步骤602，。

12、 网关系统判断所述API接口开发结果是否存在用户未请求的API接口类 型， 若是， 则标记为无效API接口， 并删除所述无效API接口； 若否， 则进入步骤603； 0015 步骤603， 通过Swagger Editor进行所述API接口开发结果的接口功能测试， 测试 其能否实现用户请求的接口功能， 若能， 则为有效的API接口开发结果， 网关系统根据用户 请求的接口访问权限对所述API接口开发结果进行权限设置并发布相应的API接口； 若否， 则发送接口功能错误的提示信息给开发端。 0016 在本发明进一步的实施例中还提供一种网关系统， 包括： 0017 判断模块， 用于接收并判断用户编写的。

13、API文档是否符合编写标准， 若是则将所述 API文档发送至解析模块和发布模块； 若否， 则标记为无效文档； 0018 发布模块， 用于接收所述API文档， 并将所述API文档发布给开发端； 0019 解析模块， 用于接收所述API文档， 并对所述API文档进行解析并存储所述API文档 的解析结果； 0020 验证模块， 用于接收开发端的API接口开发结果， 并读取所述解析模块中存储的 API文档的解析结果对所述API接口开发结果进行检验； 若检验合格， 则发布相应的API接 口； 若不合格， 则发送提示信息给开发端。 0021 在本发明进一步的实施例中还提供一种可读存储介质， 其上存储有一个。

14、或多个程 序， 其特征在于， 该一个或多个程序被一个或多个处理器执行时实现上述的基于API文档的 API接口开发管理方法。 0022 综上所述， 与现有技术相比， 本发明的有益效果是： 0023 本发明采用网关系统接收前端用户编写的API文档、 并存储所述API文档的解析结 果， 并将API文档实时发布给后端开发端， 以使后端开发端能够根据API文档进行开发， 根据 所存储的API文档的解析结果对后端的API接口开发结果进行检验， 若API接口开发结果不 满足前端用户的请求， 则发送相应的提示信息给开发端， 因此在网关系统的管理规范检验 下， 只有当API接口开发结果满足前端请求时才会被发布，。

15、 否则提示后端进行相应的修订， 以减少返工、 误工、 报错率。 进一步的， 本发明的网关系统能够将用户编写的API文档进行 web可视化， 以使开发端可以根据可视化内容进行高效开发， 并在用户更新API文档时将web 可视化内容进行实时更新， 以使后端开发端实时获知用户的需求， 有效提高开发效率和准 确率。 本发明通过管理API文档和API开发结果的方式实现对API接口的自动部署， 减少软件 项目开发的难度。 附图说明： 0024 图1为本发明方法的流程示意图； 0025 图2为本发明网关系统的结构示意图。 具体实施方式 0026 下面结合附图及具体实施例对本发明作进一步的详细描述。 但不应将。

16、此理解为本 发明上述主题的范围仅限于以下的实施例， 凡基于本发明内容所实现的技术均属于本发明 说明书 2/4 页 4 CN 111399825 A 4 的范围。 0027 如图1所示， 本发明基于API文档的管理方法， 其包括： 0028 网关系统接收并解析用户编写的API文档， 并存储所述API文档的解析结果； 0029 网关系统将所述API文档发布给开发端， 待接收到开发端的API接口开发结果后， 根据所存储的API文档的解析结果对所述API接口开发结果进行检验， 若检验合格， 则发布 相应的API接口； 若不合格， 则发送提示信息给开发端。 0030 具体的， 网关系统在接收到用户编写的。

17、API文档时， 判断所述用户编写的API文档 是否符合编写标准， 所述API文档的编写标准为OpenAPI标准， 且以yml文档存储所述API文 档的各个模块。 若是， 则对所述用户编写的API文档进行解析并保存所述API文档的解析结 果， 若否， 则网关系统无法解析该文档， 则将该文档标记为无效文档。 因此， 本发明未按照编 写标准编写或更新的API文档， 是无法被网关系统识别、 解析的， 即本发明通过管理API文档 的方式实现对API接口需求的自动归档保存， 减少软件项目开发的难度。 并且本发明在实施 时， 软件项目开发过程中无论有任何需求， 均必须基于API文档的编辑， 并依次经标准验证。

18、、 解析保存后， 用户的API接口需求才能被发布， 才生效。 0031 其中， API文档的解析结果包括用户请求的模块名称、 多个API接口名称、 UPI、 描述 类型、 接口功能以及接口访问权限等数据。 并且网关系统会采用Gitlab Runner将所述API 文档编译成基于Swagger Editor的Web可视化内容发布给开发端， 开发端可以及时根据可 视化的内容进行开发， 而不用随时查找文档内容， 极大地提高了开发效率。 在实际操作时， 用户的API开发需求可能发生变化， 用户可以更新其编写的API文档， 在用户更新的API文档 通过网关系统的编写标准检验， 被解析保存后， 网关系统会。

19、将呈现给后端的Web可视化内容 进行实时更新， 以使后端实时获取前端需求的更新， 及时更新、 避免出错， 有效提高开发效 率和准确率。 0032 进一步的， 后端根据网关系统呈现的web可视化内容完成API接口开发结果后会发 送给网关系统， 由网关系统根据所述API文档的解析结果对开发结果进行检验， 只有经过网 关系统检验合格的开发结果才能生效， 相应的API接口才会被发布。 检验过程包括三步检 验， 具体为： 0033 网关系统首先判断后端提供的API接口开发结果是否涵盖了用户请求的所有API 接口类型， 若否， 即有遗漏的API接口类型； 则发送接口类型错误的提示信息给开发端。 若 是， 。

20、则判断所述API接口开发结果是否存在用户未请求的API接口类型； 若是， 则标记为无效 API接口， 并删除所述无效API接口。 若否， 则API接口类型与前端需求一致， 则进入API接口 功能测试。 网关系统通过SwaggerEditor进行所述API接口开发结果的接口功能测试， 测试 其能否实现用户请求的接口功能， 若能， 则为有效的API接口开发结果， 网关系统根据解析 结果中的用户请求的接口访问权限对所述API接口开发结果(软件编程)进行权限设置(私 有、 公开或权限分组)并发布相应的API接口； 若否， 则发送接口功能错误的提示信息给开发 端。 0034 例如： 在网关系统中保存的解。

21、析结果中， 前端需求的接口类型包括： RPC(远程过程 调用)、 SQL(标准语言查询)、 信息交付三种， 然而后端给出的开发结果中为RPC、 SQL和文件 传输； 那么在第一步检验中网关系统会发现开发结果中遗漏了信息交付， 则会向后端发送 接口类型错误的提示信息； 由后端补充信息交付相关的软件编程。 此时， 后端补充的软件编 说明书 3/4 页 5 CN 111399825 A 5 程结果中就会有RPC、 SQL、 文件传输和信息交付四种， 存在用户未请求的API接口类型(文件 传输)， 那么就会被网关系统检测到并删除。 接着网关系统通过Swagger Editor对其中的 RPC、 SQL。

22、、 信息交付进行接口功能测试， 测试其能否实现用户请求的接口功能。 若存在软件 运行报错的情况， 则发送接口功能错误的提示信息给开发端(报错的是哪个则发对应的接 口)。 因此， 在网关系统的管理规范检验下， 只有API接口开发结果满足前端请求时才会被赋 予权限设置， 并被发布， 否则提示后端进行相应的修订， 以减少返工、 误工、 报错率。 0035 如图2所示， 本发明提供的一种网关系统， 该设备包括： 0036 判断模块， 用于接收并判断用户编写的API文档是否符合编写标准， 若是则将所述 API文档发送至解析模块和发布模块； 若否， 则标记为无效文档； 0037 发布模块， 用于接收所述A。

23、PI文档， 并将所述API文档发布给开发端； 0038 解析模块， 用于接收所述API文档， 并对所述API文档进行解析并存储所述API文档 的解析结果； 0039 验证模块， 用于接收开发端的API接口开发结果， 并读取所述解析模块中存储的 API文档的解析结果对所述API接口开发结果进行检验； 若检验合格， 则发布相应的API接 口； 若不合格， 则发送提示信息给开发端。 0040 此外， 本发明还提供一种可读存储介质， 如ROM存储设备、 移动硬盘、 U盘或者光盘 等存储器， 将一个或多个程序写入存储器中， 并一个或多个处理器来执行该存储器中的程 序。 如此当该存储器中的程序被处理器执行时实现本发明基于API文档的管理方法。 0041 以上所述仅为本发明的较佳实施例而已， 并不用以限制本发明， 凡在本发明的精 神和原则之内所作的任何修改、 等同替换和改进等， 均应包含在本发明的保护范围之内。 说明书 4/4 页 6 CN 111399825 A 6 图1 说明书附图 1/2 页 7 CN 111399825 A 7 图2 说明书附图 2/2 页 8 CN 111399825 A 8 。