[发明专利]基于API网关的API验证和API文档生成方法及系统

说明书

本发明公开了一种基于API网关的API验证和API文档生成方法及系统，属于计算机网络API网关技术领域，本发明要解决的技术问题为如何进行API标识的验证和API文档的撰写，减轻开发人员的学习负担，采用的技术方案为：该方法是将上游服务接入网关时，对接入网关API基于开放API的标准进行API规范性校验；并提供对接入网关的表示状态转移应用程序编程接口自动进行基于swagger规范的API资源文档生成；对于每个接入网关的上游服务，通过Restful API的校验工具自动对录入API进行分析，再使用相关方法查找是否符合标准；检查后，将向用户API录入的相关信息。

技术领域

本发明涉及计算机网络API网关技术领域，具体地说是一种基于API网关的API验证和API文档生成方法及系统。

背景技术

网关是一个服务器，为微服务架构中的一个基础组件，是整个系统的一个统一入口。封装了系统内部架构，为每个客户端提供一个定制的API。它可能还具有其它职责，如身份验证、监控、负载均衡、缓存、请求分片与管理、静态响应处理。

Restful API基于表示状态传输(REST)技术。在web服务开发中使用的一种架构风格和应用程序。REST之所以受欢迎，是因为它的简单性，以及它基于现有的系统和HTTP的特性来实现其目标。REST是基于web技术构建的，允许用它构建的系统表现出松散耦合、良好的可伸缩性，并利用大量可用的工具来构建它。应用程序编程接口是允许两个软件程序相互通信的代码。API规范确定了开发人员编写从操作系统或其他应用程序请求服务的程序的正确方式。

因为REST是一种架构风格，所以程序开发人员可以获得很大的灵活性。因此，没有经验的团队在没有指导的情况下创建Restful API，最终往往会遇到许多问题。

Swagger是一种Rest API的简单但强大的表示方式，标准的，语言无关，这种表示方式不但人可读，而且机器可读。可以作为Rest API的交互式文档，也可以作为Rest API的形式化接口描述，生成客户端和服务端的代码。是一种优秀的API文档格式，便于程序开发人员阅读理解。

因为REST是一种架构风格，所以程序开发人员可以获得很大的灵活性。因此，没有经验的团队在没有指导的情况下创建Restful API，最终往往会遇到许多问题。另外，对于产品服务创建的API往往需要一份API文档来对API进行管理，但是各产品编写的文档风格各异，若要求按照swagger规范进行编写又需要程序开发人员去学习相关技术。

故如何进行API标识的验证和API文档的撰写，减轻开发人员的学习负担是目前亟待解决的技术问题。

发明内容

本发明的技术任务是提供一种基于API网关的API验证和API文档生成方法及系统，来解决如何进行API标识的验证和API文档的撰写，减轻开发人员的学习负担的问题。

本发明的技术任务是按以下方式实现的，一种基于API网关的API验证和API文档生成方法，该方法是将上游服务接入网关时，对接入网关API基于开放API的标准进行API规范性校验；并提供对接入网关的表示状态转移应用程序编程接口(Restful API)自动进行基于swagger规范的API资源文档生成；对于每个接入网关的上游服务，通过Restful API的校验工具自动对录入API进行分析，再使用相关方法查找是否符合标准；检查后，将向用户API录入的相关信息。

作为优选，该方法具体如下：

S101、将需要通过API网关暴露的对外接口录入网关，通过网关实现对外暴露接口到上游服务的流量的转发；

S102、对于用户录入API网关的API，Restful API的校验工具会根据API规范对录入API的host、路径、参数、响应信息要求、请求模型及安全性进行别；并对不同类型的API进行内容解析，转换成API校验文件；