一种集中管控接口的方法与流程

1.本发明涉及接口管理技术领域，尤其涉及一种集中管控接口的方法。


背景技术：

2.由于各审批部门之间的系统相互独立，审批部门之间通常通过接口来实现审批数据共享和业务协同。随着各审批系统功能的不断完善与扩展，审批系统需要对接外部的接口数量也随之增长，虽然对接外部接口的对接方式大同小异，但因各接口功能的不同，各开发人员的编码风格不一，各接口在系统中编码位置也较为分散，当外部接口出现异常，例如返回数据错误等问题时，一般处理流程是将问题交至对接该接口的开发人员，开发人员查询接口文档以及系统编码后，对接口复测最后确认具体的问题并解决。
3.随着对接接口数量的不断增长，开发人员维护外部接口管理耗时也越来越长。虽然可以通过规范开发人员的编码来更便捷的查找接口编码以及接口文档，但仍然节省不了开发人员查阅接口编码以及接口文档、使用接口管理工具按接口文档描述配置接口参数，进行复测的时间。


技术实现要素：

4.为了解决以上技术问题，本发明提供了一种集中管控接口的方法。解决审批系统的对外接口编码分散，开发人员排查接口问题时流程繁琐等实际问题。
5.本发明的技术方案是：
6.一种集中管控接口的方法，主要包括以下内容：
7.(1)核心审批业务与外部接口调用功能解耦；
8.(2)接口中心制定统一的接口规范；
9.(3)外部接口的编码集中到接口中心；
10.(4)应用swagger技术实现接口中心在线接口文档及在线接口测试功能；
11.(5)接口中心实时记录接口调用日志。
12.进一步的，
13.将审批系统的外部接口都交由接口中心管理，审批系统与接口中心直接交互，接口中心与外部接口直接进行交互，屏蔽外部接口调用时出现的一些不可控的问题对审批系统的影响。
14.进一步的，
15.接口中心定义好统一的调用接口规范，接口按需分组；接口中心定义好统一的调用规范，接口按需分组，例如接口调用方，接口调用方式等分组，以便后续按组迁移编码或者扩展新外部接口。
16.接口规范包括接口配置的规范，接口入参出参的规范；
17.其中接口配置规范中定义接口配置需包含：应用标识，接口服务编码，接口服务名称，接口地址，接口命名空间，接口是否授权，接口授权用户名，接口授权密码，接口调用方
法路径，是否测试环境配置，备注信息。
18.各个外部接口按照此规范将接口的配置信息存入数据库中接口配置信息表中。
19.接口入参规范定义接口输入参数信息需包括：接口调用唯一标识，业务编号，应用标识，接口服务编码，接口入参，接口调用时间；接口出参规范定义接口输出参数信息需包括：接口调用唯一标识，业务编号，应用标识，接口服务编码，接口入参，接口返回状态码，接口返回提示信息，接口返回内容，接口执行调用时间。
20.进一步的，
21.将审批系统调用外部接口的编码都迁移至接口中心，并应用swagger技术，将各个外部接口都开放对应的restful接口提供给审批系统使用，并对内提供在线接口文档以及在线接口测试功能。
22.按照接口功能或者接口对接方信息将接口归入不同的接口分组，每个接口分组使用同一个接口地址前缀，接口分组中的接口用不同的接口服务编码来标识区分，接口地址信息由分组地址前缀加上接口服务编码组成。
23.根据外部接口的接口文档，在接口中心应用中进行接口的编码实现，并给各个部接口加上swagger注解，注解信息作为后续生成在线接口文档的信息来源。
24.进一步的，
25.接口中心在调用外部系统接口时，记录详细的接口调用日志，以便于开发人员或者运维人员排查接口相关的问题。
26.接口日志记录包括接口唯一标识，业务编号，应用标识，接口服务编码，接口入参，接口返回状态码，接口返回提示信息，接口返回内容，接口执行时间。
27.可通过接口日志来查询接口调用的记录的日志信息来排查接口出现的相关问题。
28.进一步的，
29.具体流程如下：
30.先收集审批系统的对外接口信息，将这些对外接口按需进行分组，然后将接口的相关编码从审批系统迁移至接口中心，迁移时代码时将接口按组归纳，按接口服务编码区分，提供各接口的对外restful服务，并按照swagger的注解规范，给接口添加接口名称，入参，出参信息的注释信息。在接口迁移完毕后，对接口中心的各接口进行功能测试，测试通过后，调整审批系统直接调用外部接口为审批系统直接调用接口中心的restful服务，中转调用外部接口；审批系统后续新对接的外部接口则直接写入接口中心，由接口中心进行统一集中管理。
31.本发明的有益效果是
32.此发明将审批系统调用的外部接口都集中到接口中心来管理，对接口进行分组，并在接口中心中定义接口接入接出规范以及接口调用规则。一方面一定程度上解决了开发人员开发对外接口编码风格不一和编码位置分散的问题，另一方面当外部接口出现超时等不可控因素时，接口中心可按制定的接口调用规则进行及时的处理，减少审批系统的核心审批功能受其影响的风险。
33.接口中心应用swagger技术后，系统开发人员可查看接口的在线接口文档，并通过在线接口文档进行接口测试。一方面开发人员可以更方便更及时的查看、维护接口文档，减少对接口文档的维护时间，另一方面，通过在线接口文档做测试，省去了开发人员查看接口
文档以及使用接口管理工具配置接口参数的时间，提升开发人员处理接口相关问题的效率。
附图说明
34.图1是核心审批业务与外部接口调用功能解耦示意图；
35.图2是swagger接口分组示意图；
36.图3是swagger在线接口文档及接口测试示意图；
37.图4是接口中心接口日志示例图；
38.图5是审批系统与接口交互示例图。
具体实施方式
39.为使本发明实施例的目的、技术方案和优点更加清楚，下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例是本发明一部分实施例，而不是全部的实施例，基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动的前提下所获得的所有其他实施例，都属于本发明保护的范围。
40.本发明提供了一种集中管控接口的方法，可应用于审批系统的外部接口调用模块，先收集审批系统的对外接口信息，将这些对外接口按需进行分组，然后将接口的相关编码从审批系统迁移至接口中心，迁移时代码时将接口按组归纳，按接口服务编码区分，提供各接口的对外restful服务，并按照swagger的注解规范，给接口添加接口名称，入参，出参等信息的注释信息。在接口迁移完毕后，对接口中心的各接口进行功能测试，测试通过后，调整审批系统直接调用外部接口为审批系统直接调用接口中心的restful服务，中转调用外部接口。审批系统后续新对接的外部接口则直接写入接口中心，由接口中心进行统一集中管理。如图5所示。
41.应用于审批系统的对外接口调用功能，在审批系统需要对接外部接口时，将调用外部接口的编码写入接口中心做统一管理。实现步骤如下：
42.(1)核心审批业务与外部接口调用功能解耦，将原有审批系统调用外部接口的工作交由接口中心，接口中心中设定一套接口调用规则，例如超时20s就自动返回给审批系统调用失败的结果，屏蔽调用外部接口超时时间长，外部接口调用异常等不可控问题。如图1所示。
43.(2)接口中心制定统一的接口规范。接口规范包括接口配置的规范，接口入参出参的规范。
44.其中接口配置规范中定义接口配置需包含：应用标识，接口服务编码，接口服务名称，接口地址，接口命名空间，接口是否授权，接口授权用户名，接口授权密码，接口调用方法路径，是否测试环境配置，备注信息。各个外部接口按照此规范将接口的配置信息存入数据库中接口配置信息表中。
45.接口入参规范定义接口输入参数信息需包括：接口调用唯一标识，业务编号，应用标识，接口服务编码，接口入参，接口调用时间；接口出参规范定义接口输出参数信息需包括：接口调用唯一标识，业务编号，应用标识，接口服务编码，接口入参，接口返回状态码，接口返回提示信息，接口返回内容，接口执行调用时间。
46.(3)外部接口的编码集中到接口中心，将审批系统需要调用的各个外部接口的编码集中至接口中心，按照接口功能或者接口对接方等信息将接口归入不同的接口分组，每个接口分组使用同一个接口地址前缀，接口分组中的接口用不同的接口服务编码来标识区分，接口地址信息由分组地址前缀加上接口服务编码组成。开发人员根据外部接口的接口文档，在接口中心应用中进行接口的编码实现，并给各个部接口加上swagger注解，注解信息作为后续生成在线接口文档的信息来源。如图2所示。
47.(4)应用swagger技术实现接口中心在线接口文档及在线接口测试功能，根据第(3)点中的规范，按接口分组，应用swagger生成分组的在线接口文档，可应用在线接口文档自带的接口在线测试功能进行接口测试。如图3所示。
48.(5)接口中心实时记录接口调用日志，接口日志记录包括接口唯一标识，业务编号，应用标识，接口服务编码，接口入参，接口返回状态码，接口返回提示信息，接口返回内容，接口执行时间。系统开发人员以及运维人员都可以通过接口日志来查询接口调用的记录的日志信息来排查接口出现的相关问题。如图4所示。
49.本发明解决审批系统对接各外部接口时，不同的开发人员编码风格不一，各接口编码位置分散，排查接口相关问题流程繁琐，维护外部接口管理耗时多等实际问题，以进一步提高系统开发人员处理接口相关问题的效率
50.以上所述仅为本发明的较佳实施例，仅用于说明本发明的技术方案，并非用于限定本发明的保护范围。凡在本发明的精神和原则之内所做的任何修改、等同替换、改进等，均包含在本发明的保护范围内。