一种API文档查找方法技术

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

【技术实现步骤摘要】
一种API文档查找方法
本专利技术涉及计算机
，具体涉及一种API文档查找方法。
技术介绍
由于目前微服务架构下软件研发过程本身的复杂性和持续性以及团队内外沟通的必要性，不同的研发角色(比如：app研发、h5研发、后端研发)之间需要对应用程序接口(ApplicationProgrammingInterface，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文档查看效率及团队沟通效率。具体实施方式以下结合具体实施例对本专利技术作具体的介绍。本专利技术实施例提供的API文档查找方法包括以下步骤：S101，通过nginx工具配置各个API文档所在服务器的域名。S102，根据各个API文档所在服务器的域名，生成统一的URL地址。其中，通过该URL地址，研发用户可以采用浏览器通过统一的入口直达聚合平台首页。采用html、css、boostrap、ace等语言进行布局和排版渲染，采用jquery框架以及相关插件等javascript技术支持页面内的各个环境的跳转、搜索事件以及点击事件处理、高亮显示等。S103，根据URL地址，从Eurake注册中心获取对应的API文档列表。其中，针对每个API文档，通过http协议跨域访问对应的服务中的v2/api-docs接口，获取当前API文档中接口信息数据(json格式)，解析当前API文档后将当前API文档保存至本地存储，支持本地某对一个API文档的查找功能。其中，API文档中接口v2/api-docs中的信息数据来源于利用springfox解析通过swagger注解标识的web接口，通过对web接口进行扫描和反射，最终包装成了对应的javabean组件，然后将javabean组件转化为json格式返回给。S104，遍历API文档列表中的各个API文档并获取各个API文档的检查路径healthCheckUrl。S105，根据各个API文档的检查路径healthCheckUrl，获取各个API文档的名称和地址。S106，根据各个API文档的名称和地址，查找具体的API文档。可选地，在通过nginx工具配置各个API文档所在服务器的域名之前，该方法还包括：利用swagger工具，实时将从Eurake注册中心获取的各个API文档聚合在一起。可选地，在根据URL地址，从Eurake注册中心获取对应的API文档列表之后，该方法还包括：利用http协议，跨域请求对API文档列表的一个或多个API文档进行在线编辑。作为一个具体的实施例，通过ajax网页开发技术，对API文档列表的一个或多个API文档进行在线编辑。可选地，在根据URL地址，从Eurake注册中心获取对应的API文档列表之后，该方法还包括：利用监听配置中心，将API文档列表中的各个API文档设置为有效状态或无效状态。作为一个具体的实施例，基于springboot的自动配置机制，以maven项目对象模型的pom文件的方式提供对应的xxx-starter.jar包来支持springcloud方式微服务架构下的目标应用无感接入，并且利用@ConditionalOnProperty监听配置中心中的配置项gofun.swagger.enable来控制应用在不同环境下的API文档是否有效。本专利技术实施例提供的API文档查找方法，通过nginx工具配置各个API文档所在服务器的域名，根据各个API文档所在服务器的域名，生成统一的URL地址，根据URL地址，从Eurake注册中心获取对应的API文档列表，遍历API文档列表中的各个API文档并获取各个API文档的检查路径healthCheckUrl，根据各个API文档的检查路径healthCheckUrl，获取各个API文档的名称和地址，根据各个API文档的名称和地址，查找具体的API文档，能够及时发现新增的API文档，提高了API文档查看效率及团队沟通效率。在上述实施例中，对各个实施例的描述都各有侧重，某个实施例中没有详述的部分，可以参见其他实施例的相关描述。还需要说明的是，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、商品或者设备不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、商品或者设备所固有的要素。在没有更多限制的情况下，由语句“包括一个……”限定的要素，并不排除在包括要素的过程、方法、商品或者设备中还存在另外的相同要素。本领域技术人员应明白，本申请的实施例可提供为方法、系统或计算机程序产品。因此，本申请可采用完全硬件实施例、完全软件实施例或结合软件和硬件本文档来自技高网...

【技术保护点】
1.一种API文档查找方法，其特征在于，包括：/n通过nginx工具配置各个API文档所在服务器的域名；/n根据所述各个API文档所在服务器的域名，生成统一的URL地址；/n根据所述URL地址，从Eurake注册中心获取对应的API文档列表；/n遍历所述API文档列表中的各个API文档并获取所述各个API文档的检查路径healthCheckUrl；/n根据所述各个API文档的检查路径healthCheckUrl，获取所述各个API文档的名称和地址；/n根据所述各个API文档的名称和地址，查找具体的API文档。/n

【技术特征摘要】
1.一种API文档查找方法，其特征在于，包括：
通过nginx工具配置各个API文档所在服务器的域名；
根据所述各个API文档所在服务器的域名，生成统一的URL地址；
根据所述URL地址，从Eurake注册中心获取对应的API文档列表；
遍历所述API文档列表中的各个API文档并获取所述各个API文档的检查路径healthCheckUrl；
根据所述各个API文档的检查路径healthCheckUrl，获取所述各个API文档的名称和地址；
根据所述各个API文档的名称和地址，查找具体的API文档。


2.根据权利要求1所述的API文档查找方法，其特征在于，在通过nginx工具配置各个API文档所在服务器的域名之前，所述方法还包括：
利用swagger工具，实时将从Eurake注册中心获取的各个API文档聚合在一起。


3.根据权利要求1所述的API文档查找方法，其特征...

【专利技术属性】
技术研发人员：孙全超，
申请(专利权)人：北京首汽智行科技有限公司，
类型：发明
国别省市：北京;11