[发明专利]一种API文档查找方法

说明书

本发明公开的API文档查找方法，涉及计算机技术领域，通过nginx工具配置各个API文档所在服务器的域名，根据各个API文档所在服务器的域名，生成统一的URL地址，根据URL地址，从Eurake注册中心获取对应的API文档列表，遍历API文档列表中的各个API文档并获取各个API文档的检查路径healthCheckUrl，根据各个API文档的检查路径healthCheckUrl，获取各个API文档的名称和地址，根据各个API文档的名称和地址，查找具体的API文档，能够及时发现新增的API文档，提高了API文档查看效率及团队沟通效率。

技术领域

本发明涉及计算机技术领域，具体涉及一种API文档查找方法。

背景技术

由于目前微服务架构下软件研发过程本身的复杂性和持续性以及团队内外沟通的必要性，不同的研发角色(比如：app研发、h5研发、后端研发)之间需要对应用程序接口(Application Programming Interface，API)进行文档化和规范化处理。

现有的技术方案大多是简单地引入springfox工具、swagger工具到单个API文档中，由于该方案存在不同的文档分散在各个微服务项目中，导致相关研发人员查看某个具体API文档时需要多步操作。首先，需要研发人员提前沟通API文档是否已提供，并定位到API文档所在的环境，其次，需要研发人员在具体的环境中定位API文档所在服务器的IP地址和端口，再次，需要研发人员通过具体的服务器的IP地址以及端口，整个过程比较繁琐，以至于影响到API文档的查找效率，API文档更新不及时，影响团队沟通效率。

发明内容

为解决现有技术的不足，本发明实施例提供了一种API文档查找方法，该方法包括以下步骤：

通过nginx工具配置各个API文档所在服务器的域名；

根据所述各个API文档所在服务器的域名，生成统一的URL地址；

根据所述URL地址，从Eurake注册中心获取对应的API文档列表；

遍历所述API文档列表中的各个API文档并获取所述各个API文档的检查路径healthCheckUrl；

根据所述各个API文档的检查路径healthCheckUrl，获取所述各个API文档的名称和地址；

根据所述各个API文档的名称和地址，

根据所述各个API文档的名称和地址，查找具体的API文档。

优选地，在通过nginx工具配置各个API文档所在服务器的域名之前，所述方法还包括：

利用swagger工具，实时将从Eurake注册中心获取的各个API文档聚合在一起。

优选地，在根据所述URL地址，从Eurake注册中心获取对应的API文档列表之后，所述方法还包括：

利用http协议，跨域请求对所述API文档列表的一个或多个API文档进行在线编辑。

优选地，在根据所述URL地址，从Eurake注册中心获取对应的API文档列表之后，所述方法还包括：

利用监听配置中心，将所述API文档列表中的各个API文档设置为有效状态或无效状态。

本发明实施例提供的API文档查找方法具有以下有益效果：

利用swagger工具，实时将从Eurake注册中心获取的各个API文档聚合在一起并统一API文档的入口，能够及时发现新增的API文档，提高了API文档查看效率及团队沟通效率。

具体实施方式

以下结合具体实施例对本发明作具体的介绍。