[发明专利]一种基于API文档的API接口开发管理方法及系统

说明书

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

技术领域

本发明涉及计算机技术领域，特别涉及一种基于API文档的API接口开发管理方法及系统。

背景技术

随着web技术的发展，前后端分离成为越来越多互联网公司构建应用的方式。前后端分离的优势是一套API可被多个客户端复用，分工和协作被细化，大大提高了编码效率，但是由于前后端分离，后端的开发结果往往不可靠，容易遗漏前端的接口需求或者给前端一些错误的API接口，这种错误则需要前端用户在使用后端的开发结果后才能被发现，缺乏一个有效性的检验。并且由于API是一些预先定义的函数，一旦前端用户需求变化，则需要花费精力频繁修改和更新API接口文档，后端用户也无法及时获知前端需求的更新，容易造成后端开发的不停修改、返工，致使相应的软件接口开发过程错误率高、效率低下。因此，为了进一步提升开发软件项目的效率，急需一种有效的API文挡的API接口开发管理方法及系统，以解决API接口开发结果不可靠及文档更新不及时的问题。

发明内容

本发明的目的在于克服现有技术中的上述不足，提供一种基于API文档的API接口开发管理方法及系统。

为了实现上述目的，本发明提供了以下技术方案：

一种基于API文档的API接口开发管理方法，包括：

网关系统接收用户编写的API文档，并判断所述API文档是否符合编写标准，若是，则对所述API文档进行解析并存储所述API文档的解析结果，并将所述API文档发布给开发端，若否，则标记为无效文档；

待接收到开发端的API接口开发结果后，网关系统根据存储的API文档的解析结果对所述API接口开发结果进行检验，若检验合格，则发布相应的API接口；若不合格，则发送提示信息给开发端。

优选的，所述API文档的编写标准为OpenAPI标准，且以yml文档存储所述API文档的各个模块。

优选的，采用Gitlab Runner将所述API文档编译成基于Swagger Editor的Web可视化内容发布给开发端。

优选的，当用户更新其编写的API文档且用户更新的API文档符合所述编写标准时，对所述Web可视化内容进行实时更新。

优选的，所述API文档的解析结果至少包括用户请求的多个API接口类型、接口功能以及接口访问权限。

优选的，根据所述API文档的解析结果对所述API接口开发结果进行检验，包括：

步骤601，网关系统判断所述API接口开发结果是否涵盖了用户请求的所有API接口类型，若是，则进入步骤602；若否，即有遗漏的API接口类型，则发送接口类型错误的提示信息给开发端；

步骤602，网关系统判断所述API接口开发结果是否存在用户未请求的API接口类型，若是，则标记为无效API接口，并删除所述无效API接口；若否，则进入步骤603；