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

权利要求书

1.一种基于Swagger的API文档管理系统，其特征在于：所述系统包括：

发布模块，用于发布业务系统，在业务系统中集成Swagger；

用户界面模块，用于新增业务系统，并对API文档数据进行采集；

匹配模块，用于完成API文档当前版本和历史版本的变更匹配，并将比对结果展示到用户界面模块；

数据库，用于对采集到的API文档的数据进行存储。

2.根据权利要求1所述的一种基于Swagger的API文档管理系统，其特征在于：所述发布模块包括一个或一个以上的业务系统。

3.一种基于Swagger的API文档管理方法，其特征在于：所述方法应用如权利要求1-2任一权利要求所述的管理系统，具体包括以下步骤：

S1：利用发布模块集成Swagger，按照Swagger提供的功能完成开发后发布业务系统；

S2：利用用户界面模块，对新增业务系统进行基础数据的配置；

S3：在S2步骤配置好的业务系统对应的子模块，编写所需的基础数据，根据配置的SwaggerAPI路径采集业务系统的API文档数据，并将采集到的API文档数据持久存储到数据库；

S4：选择需要比对的API文档，以及需要比对的API文档版本；

S5：利用匹配模块，对所选择的API文档的当前版本和比对版本进行变更匹配，并将比对结果展示到用户界面模块。

4.根据权利要求3所述的一种基于Swagger的API文档管理方法，其特征在于：所述S2步骤中，基础数据的配置包括但不限于业务系统名称、描述、Swagger提供的API路径。

5.根据权利要求3所述的一种基于Swagger的API文档管理方法，其特征在于：所述S4步骤的API文档内包含有具体的API信息，所述API信息包括API的URL、API的入参和出参以及参数说明。

6.根据权利要求3所述的一种基于Swagger的API文档管理方法，其特征在于：所述比对结果包括变更明细、变更内容和变更说明。

7.根据权利要求3-6任一权利要求所述的一种基于Swagger的API文档管理方法，其特征在于：所述匹配模块在匹配API文档的当前版本和比对版本时，先匹配两个版本的API的URL来标识是否为同一个接口，再通过匹配结果标识URL是新增、删除还是有变动，最后再匹配同一个API下面的参数和参数说明变更内容。

8.一种可读存储介质，其上存储有一个或多个程序，其特征在于，该一个或多个程序被一个或多个处理器执行时实现权利要求7所述的一种基于Swagger的API文档管理方法。