CN112230891A - 接口文档的集成方法、装置、服务器及计算机存储介质 - Google Patents
接口文档的集成方法、装置、服务器及计算机存储介质 Download PDFInfo
- Publication number
- CN112230891A CN112230891A CN202011084630.3A CN202011084630A CN112230891A CN 112230891 A CN112230891 A CN 112230891A CN 202011084630 A CN202011084630 A CN 202011084630A CN 112230891 A CN112230891 A CN 112230891A
- Authority
- CN
- China
- Prior art keywords
- interface
- target service
- document
- gateway
- interface document
- Prior art date
- Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
- Pending
Links
- 238000000034 method Methods 0.000 title claims abstract description 47
- 230000010354 integration Effects 0.000 title claims abstract description 26
- 238000004590 computer program Methods 0.000 claims description 15
- 230000004931 aggregating effect Effects 0.000 claims description 2
- 230000002776 aggregation Effects 0.000 claims description 2
- 238000004220 aggregation Methods 0.000 claims description 2
- 238000011161 development Methods 0.000 abstract description 10
- 238000012360 testing method Methods 0.000 abstract description 9
- 238000010586 diagram Methods 0.000 description 8
- 230000006870 function Effects 0.000 description 8
- 230000003287 optical effect Effects 0.000 description 6
- 238000005516 engineering process Methods 0.000 description 5
- 239000003795 chemical substances by application Substances 0.000 description 4
- 238000000926 separation method Methods 0.000 description 3
- 238000004891 communication Methods 0.000 description 2
- 238000012986 modification Methods 0.000 description 2
- 230000004048 modification Effects 0.000 description 2
- 239000013307 optical fiber Substances 0.000 description 2
- 230000000644 propagated effect Effects 0.000 description 2
- 239000004065 semiconductor Substances 0.000 description 2
- 238000007792 addition Methods 0.000 description 1
- 238000003491 array Methods 0.000 description 1
- 238000012217 deletion Methods 0.000 description 1
- 230000037430 deletion Effects 0.000 description 1
- 239000006185 dispersion Substances 0.000 description 1
- 238000012423 maintenance Methods 0.000 description 1
- 238000012545 processing Methods 0.000 description 1
Images
Classifications
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F8/00—Arrangements for software engineering
- G06F8/20—Software design
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F11/00—Error detection; Error correction; Monitoring
- G06F11/36—Preventing errors by testing or debugging software
- G06F11/3668—Software testing
- G06F11/3672—Test management
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F8/00—Arrangements for software engineering
- G06F8/30—Creation or generation of source code
- G06F8/38—Creation or generation of source code for implementing user interfaces
Landscapes
- Engineering & Computer Science (AREA)
- Theoretical Computer Science (AREA)
- General Engineering & Computer Science (AREA)
- Software Systems (AREA)
- Physics & Mathematics (AREA)
- General Physics & Mathematics (AREA)
- Computer Hardware Design (AREA)
- Quality & Reliability (AREA)
- Human Computer Interaction (AREA)
- Computer And Data Communications (AREA)
Abstract
本申请提供了一种接口文档的集成方法、装置、服务器及计算机存储介质，该方法包括：当网关服务启动时，确定需要网关代理的每一个目标服务；其中，所述目标服务包括：业务服务和网关服务；然后，获取所述需要网关代理的每一个目标服务对应的接口文档；最终，对所述需要网关代理的每一个目标服务对应的接口文档进行集成，得到接口文档集合。从而在前端开发和测试人员在需要找到目标服务的接口文档时，可以在集成后的接口文档集合中，查找目标服务的接口文档，并根据目标服务的每个接口上添加的接口对应的说明信息进行查找。
Description
技术领域
本申请涉及计算机技术领域，特别涉及一种接口文档的集成方法、装置、服务器及计算机存储介质。
背景技术
前后端分离技术已经逐渐成为互联网项目的一种标准的开发模式。前后端分离技术即前端开发不需要部署后端语言环境，后端开发也不需要前端为其提供任何程序辅助；后端只管展现各种Api接口，供给前端进行数据的增删改查，不负责生成HTML页面；同时，测试人员也只需要测试后端接口即可。
目前，前后端分离技术通常采用业界公用通用的方式来做接口契约开发，它可以动态生成Api接口文档，做到代码与接口文档同源，并提供UI界面进行接口查看，在线进行接口测试等，极大降低沟通成本，解放开发人员的维护更新成本，减少由于信息不对称造成的前后端矛盾。
但是，随着系统变得异常庞大以后。单应用已无法支撑海量业务。因此，需要按业务服务进行拆分，在拆分后。由于一个应用会划分为很多个子应用，这就导致前端开发和测试人员需要到多个地方去找后端所提供的接口文档。
发明内容
有鉴于此，本申请提供一种接口文档的集成方法、装置、服务器及计算机存储介质，用于在前端开发和测试人员在需要找到目标服务的接口文档时，可以在集成后的接口文档集合中，查找目标服务的接口文档。
本申请第一方面提供了一种接口文档的集成方法，包括：
当网关服务启动时，确定需要网关代理的每一个目标服务；其中，所述目标服务包括：业务服务和网关服务；
获取所述需要网关代理的每一个目标服务对应的接口文档；
对所述需要网关代理的每一个目标服务对应的接口文档进行集成，得到接口文档集合。
可选的，一个所述目标服务对应的接口文档的生成方法，包括：
获取所述目标服务的文档支持包；
利用所述文档支持包中的数据，配置所述目标服务的文档参数；
为配置文档参数后的所述目标服务的每个接口，添加所述接口对应的说明信息，得到所述目标服务对应的接口文档。
可选的，所述对所述需要网关代理的每一个目标服务对应的接口文档进行集成，得到接口文档集合，包括：
将每一个所述目标服务对应的接口文档的路径信息进行集合，得到最终的文档对象；
利用所述最终的文档对象覆盖所述网关的文档对象，得到所述接口文档集合。
可选的，所述对所述需要网关代理的每一个目标服务对应的接口文档进行集成，得到接口文档集合之后，还包括：
根据所述接口文档集合，生成UI界面。
可选的，所述文档支持包提供gradle版本或maven版本的集成支持。
本申请第二方面提供了一种接口文档的集成装置，包括：
确定单元，用于当网关服务启动时，确定需要网关代理的每一个目标服务；其中，所述目标服务包括：业务服务和网关服务；
第一获取单元，用于获取所述需要网关代理的每一个目标服务对应的接口文档；
集成单元，用于对所述需要网关代理的每一个目标服务对应的接口文档进行集成，得到接口文档集合。
可选的，一个所述目标服务对应的接口文档的生成单元，包括：
第二获取单元，用于获取所述目标服务的文档支持包；
配置单元，用于利用所述文档支持包中的数据，配置所述目标服务的文档参数；
添加单元，用于为配置文档参数后的所述目标服务的每个接口，添加所述接口对应的说明信息，得到所述目标服务对应的接口文档。
可选的，所述集成单元，包括：
集合单元，用于将每一个所述目标服务对应的接口文档的路径信息进行集合，得到最终的文档对象；
覆盖单元，用于利用所述最终的文档对象覆盖所述网关的文档对象，得到所述接口文档集合。
可选的，所述接口文档的集成装置，还包括：
生成单元，用于根据所述接口文档集合，生成UI界面。
可选的，所述文档支持包提供gradle版本或maven版本的集成支持。
本申请第三方面提供了一种服务器，包括：
一个或多个处理器；
存储装置，其上存储有一个或多个程序；
当所述一个或多个程序被所述一个或多个处理器执行时，使得所述一个或多个处理器实现如第一方面任意一项所述的方法。
本申请第四方面提供了一种计算机存储介质，其上存储有计算机程序，其中，所述计算机程序被处理器执行时实现如第一方面任意一项所述的方法。
由以上方案可知，本申请提供的一种接口文档的集成方法、装置、服务器及计算机存储介质中，该方法包括：当网关服务启动时，确定需要网关代理的每一个目标服务；其中，所述目标服务包括：业务服务和网关服务；然后，获取所述需要网关代理的每一个目标服务对应的接口文档；最终，对所述需要网关代理的每一个目标服务对应的接口文档进行集成，得到接口文档集合。从而在前端开发和测试人员在需要找到目标服务的接口文档时，可以在集成后的接口文档集合中，查找目标服务的接口文档，并根据目标服务的每个接口上添加的接口对应的说明信息进行查找。
附图说明
为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明的实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据提供的附图获得其他的附图。
图1为本申请实施例提供的一种接口文档的集成方法的具体流程图；
图2为本申请另一实施例提供的一种目标服务对应的接口文档的生成方法的具体流程图；
图3为本申请另一实施例提供的一种接口文档的集成方法的具体流程图；
图4为本申请另一实施例提供的一种接口文档的集成装置的示意图；
图5为本申请另一实施例提供的一种目标服务对应的接口文档的生成装置的示意图；
图6为本申请另一实施例提供的一种接口文档的集成装置的示意图；
图7为本申请另一实施例提供的一种执行接口文档的集成方法的服务器的示意图。
具体实施方式
下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。
本文使用的术语“包括”及其变形是开放性包括，即“包括但不限于”。术语“基于”是“至少部分地基于”。术语“一个实施例”表示“至少一个实施例”；术语“另一实施例”表示“至少一个另外的实施例”；术语“一些实施例”表示“至少一些实施例”。其他术语的相关定义将在下文描述中给出。
需要注意，本公开中提及的“第一”、“第二”等概念仅用于对不同的装置、模块或单元进行区分，并非用于限定这些装置、模块或单元所执行的功能的顺序或者相互依存关系。
需要注意，本公开中提及的“一个”、“多个”的修饰是示意性而非限制性的，本领域技术人员应当理解，除非在上下文另有明确指出，否则应该理解为“一个或多个”。
本申请实施例提供了一种接口文档的集成方法，如图1所示，具体包括以下步骤：
S101、当网关服务启动时，确定需要网关代理的每一个目标服务。
其中，目标服务包括：业务服务和网关服务。业务服务可以包括但不限于用户服务、航班服务等。
需要说明的是，当网关服务启动时，需要网关代理的目标服务的类型可以相同也可以不同，如：当网关启动时，需要网关代理的目标服务为用户服务A、用户服务B、航班服务A和网关服务A；当网关启动时，需要网关代理的目标服务为网关服务A、网关服务B和航班服务A。
具体的，当网关服务启动时，确定本次需要网关进行代理的每一个目标服务。
S102、获取需要网关代理的每一个目标服务对应的接口文档。
其中，每一个目标服务对应的接口文档中，至少包括目标服务的文档参数、以及目标服务对应的接口的说明信息。
需要说明的是，在实际的应用过程中，目标服务可能会对应多个接口，那么就需要获取木妖网关代理的每一个目标服务对应的每一个接口的接口文档。
可选的，在本申请的另一实施例中，一个目标服务对应的接口文档的生成方法，如图2所示，包括：
S201、获取目标服务的文档支持包。
可选的，在本申请的另一实施例中，文档支持包提供gradle版本或maven版本的集成支持。
S202、利用文档支持包中的数据，配置目标服务的文档参数。
其中，文档参数可以是但不限于文档版本、文档描述、作者信息等信息，可以根据实际情况对文档支持包进行配置，进而可以对目标服务的文档参数进行配置，此处不做限定。
具体的，目标服务的文档参数可以如表1所示：
表1
S203、为配置文档参数后的目标服务的每个接口，添加接口对应的说明信息，得到目标服务对应的接口文档。
其中，接口对应的说明信息可以是但不限于接口名称，接口中各个参数的说明、返回值说明信息，可以根据实际的应用情况进行对应的调整，此处不做限定。
需要说明的是，在目标服务启动后，可以根据自动生成该目标服务的接口文档，可以是但不限于以json格式提供服务。
具体的，以登录接口服务添加接口对应的说明信息，得到登录接口服务对应的接口文档为例：
其中，@Api用于将接口分组；@ApiOperation表示一个具体的接口说明；@ApiParam表示一个参数的说明。
S103、对需要网关代理的每一个目标服务对应的接口文档进行集成，得到接口文档集合。
具体的，在网关服务启动时，会自动运行文档集成代码，将需要网关代理的每一个目标服务对应的接口文档进行集成，得到接口文档集合。
对需要网关代理的每一个目标服务对应的接口文档进行集成，得到接口文档集合的实现方式可以是：
通过以上代码将各个目标服务的文档全部集成到了网关，解决了文档分散问题，可在网关层分组查看所有业务服务的Api文档。并且，如果下游服务需要使用目标服务的文档中的会话控制信息(session)，可以将Api网关session中的数据序列会为字符串，做为http头信息，传送到下游，下游服务再读取http头信息，将它反序列化后存入session；这样就做到了将session统一在网关处进行管理。
可选的，在本申请的另一实施例中，步骤S103的一种实施方式，如图3所示，包括：
S301、将每一个目标服务对应的接口文档的路径信息进行集合，得到最终的文档对象。
具体的，将每一个目标服务对应的接口文档的路径信息进行集合，得到包括所有目标服务对应的接口问文档的路径信息的最终文档对象。
S302、利用最终的文档对象覆盖网关的文档对象，得到接口文档集合。
具体的，利用步骤S301获取得到的最终文档对象，替换网关原有的文档对象，得到接口文档集合。
可选的，在本申请的另一实施例中，在步骤S103之后的一种实施方式，还包括：
根据接口文档集合，生成UI界面。
具体的，利用步骤S103生成的接口文档集合，生成对应的UI界面，以便前端以及测试人员使用，并且提供在线测试功能，进一步的降低测试人员对接口进行测试的难度。
由以上方案可知，本申请提供的一种接口文档的集成方法中，当网关服务启动时，确定需要网关代理的每一个目标服务；其中，目标服务包括：业务服务和网关服务；然后，获取需要网关代理的每一个目标服务对应的接口文档；最终，对需要网关代理的每一个目标服务对应的接口文档进行集成，得到接口文档集合。从而在前端开发和测试人员在需要找到目标服务的接口文档时，可以在集成后的接口文档集合中，查找目标服务的接口文档，并根据目标服务的每个接口上添加的接口对应的说明信息进行查找。
附图中的流程图和框图，图示了按照本公开各种实施例的系统、方法和计算机程序产品的可能实现的体系架构、功能和操作。在这点上，流程图或框图中的每个方框可以代表一个模块、程序段、或代码的一部分，该模块、程序段、或代码的一部分包含一个或多个用于实现规定的逻辑功能的可执行指令。也应当注意，在有些作为替换的实现中，方框中所标注的功能也可以以不同于附图中所标注的顺序发生。例如，两个接连地表示的方框实际上可以基本并行地执行，它们有时也可以按相反的顺序执行，这依所涉及的功能而定。也要注意的是，框图和/或流程图中的每个方框、以及框图和/或流程图中的方框的组合，可以用执行规定的功能或操作的专用的基于硬件的系统来实现，或者可以用专用硬件与计算机指令的组合来实现。
本公开实施方式中的多个装置之间所交互的消息或者信息的名称仅用于说明性的目的，而并不是用于对这些消息或信息的范围进行限制。
可以以一种或多种程序设计语言或其组合来编写用于执行本公开的操作的计算机程序代码，上述程序设计语言包括但不限于面向对象的程序设计语言—诸如Python、Java、C++等，还包括常规的过程式程序设计语言—诸如“C”语言或类似的程序设计语言。程序代码可以完全地在用户计算机上执行、部分地在用户计算机上执行、作为一个独立的软件包执行、部分在用户计算机上部分在远程计算机上执行、或者完全在远程计算机或服务器上执行。在涉及远程计算机的情形中，远程计算机可以通过任意种类的网络——包括局域网(LAN)或广域网(WAN)—连接到用户计算机，或者，可以连接到外部计算机(例如利用因特网服务提供商来通过因特网连接)。
本申请的另一实施例提供了一种接口文档的集成装置，如图4所示，具体包括：
确定单元401，用于当网关服务启动时，确定需要网关代理的每一个目标服务。
其中，目标服务包括：业务服务和网关服务。业务服务可以包括但不限于用户服务、航班服务等。
第一获取单元402，用于获取需要网关代理的每一个目标服务对应的接口文档。
其中，每一个目标服务对应的接口文档中，至少包括目标服务的文档参数、以及目标服务对应的接口的说明信息。
可选的，在本申请的另一实施例中，一个目标服务对应的接口文档的生成单元，如图5所示，包括：
第二获取单元501，用于获取目标服务的文档支持包。
可选的，在本申请的另一实施例中，文档支持包提供gradle版本或maven版本的集成支持。
本申请上述实施例公开的单元的具体工作过程，可参见对应的方法实施例内容，此处不再赘述。
配置单元502，用于利用文档支持包中的数据，配置目标服务的文档参数。
其中，文档参数可以是但不限于文档版本、文档描述、作者信息等信息，可以根据实际情况对文档支持包进行配置，进而可以对目标服务的文档参数进行配置，此处不做限定。
添加单元503，用于为配置文档参数后的目标服务的每个接口，添加接口对应的说明信息，得到目标服务对应的接口文档。
其中，接口对应的说明信息可以是但不限于接口名称，接口中各个参数的说明、返回值说明信息，可以根据实际的应用情况进行对应的调整，此处不做限定。
本申请上述实施例公开的单元的具体工作过程，可参见对应的方法实施例内容，如图2所示，此处不再赘述。
集成单元403，用于对需要网关代理的每一个目标服务对应的接口文档进行集成，得到接口文档集合。
本申请上述实施例公开的单元的具体工作过程，可参见对应的方法实施例内容，如图1所示，此处不再赘述。
可选的，在本申请的另一实施例中，集成单元403的一种实施方式，如图6所示，包括：
集合单元601，用于将每一个目标服务对应的接口文档的路径信息进行集合，得到最终的文档对象。
覆盖单元602，用于利用最终的文档对象覆盖网关的文档对象，得到接口文档集合。
本申请上述实施例公开的单元的具体工作过程，可参见对应的方法实施例内容，如图3所示，此处不再赘述。
可选的，在本申请的另一实施例中，接口文档的集成装置，还可以包括：
生成单元，用于根据所述接口文档集合，生成UI界面。
本申请上述实施例公开的单元的具体工作过程，可参见对应的方法实施例内容，此处不再赘述。
由以上方案可知，本申请提供的一种接口文档的集成装置中，当网关服务启动时，确定单元401确定需要网关代理的每一个目标服务；其中，目标服务包括：业务服务和网关服务；然后，第一获取单元402获取需要网关代理的每一个目标服务对应的接口文档；最终，集成单元403对需要网关代理的每一个目标服务对应的接口文档进行集成，得到接口文档集合。从而在前端开发和测试人员在需要找到目标服务的接口文档时，可以在集成后的接口文档集合中，查找目标服务的接口文档，并根据目标服务的每个接口上添加的接口对应的说明信息进行查找。
描述于本公开实施例中所涉及到的单元可以通过软件的方式实现，也可以通过硬件的方式来实现。其中，单元的名称在某种情况下并不构成对该单元本身的限定，例如，第一获取单元还可以被描述为“获取至少两个网际协议地址的单元”。
本文中以上描述的功能可以至少部分地由一个或多个硬件逻辑部件来执行。例如，非限制性地，可以使用的示范类型的硬件逻辑部件包括：现场可编程门阵列(FPGA)、专用集成电路(ASIC)、专用标准产品(ASSP)、片上系统(SOC)、复杂可编程逻辑设备(CPLD)等等。
本申请另一实施例提供了一种服务器，如图7所示，包括：
一个或多个处理器701。
存储装置702，其上存储有一个或多个程序。
当所述一个或多个程序被所述一个或多个处理器701执行时，使得所述一个或多个处理器701实现如上述实施例中任意一项所述的方法。
本申请另一实施例提供了一种计算机存储介质，其上存储有计算机程序，其中，计算机程序被处理器执行时实现如上述实施例中任意一项所述的方法。
在本公开的上下文中，机器可读介质可以是有形的介质，其可以包含或存储以供指令执行系统、装置或设备使用或与指令执行系统、装置或设备结合地使用的程序。机器可读介质可以是机器可读信号介质或机器可读储存介质。机器可读介质可以包括但不限于电子的、磁性的、光学的、电磁的、红外的、或半导体系统、装置或设备，或者上述内容的任何合适组合。机器可读存储介质的更具体示例会包括基于一个或多个线的电气连接、便携式计算机盘、硬盘、随机存取存储器(RAM)、只读存储器(ROM)、可擦除可编程只读存储器(EPROM或快闪存储器)、光纤、便捷式紧凑盘只读存储器(CD-ROM)、光学储存设备、磁储存设备、或上述内容的任何合适组合。
需要说明的是，本公开上述的计算机可读介质可以是计算机可读信号介质或者计算机可读存储介质或者是上述两者的任意组合。计算机可读存储介质例如可以是但不限于电、磁、光、电磁、红外线、或半导体的系统、装置或器件，或者任意以上的组合。计算机可读存储介质的更具体的例子可以包括但不限于：具有一个或多个导线的电连接、便携式计算机磁盘、硬盘、随机访问存储器(RAM)、只读存储器(ROM)、可擦式可编程只读存储器(EPROM或闪存)、光纤、便携式紧凑磁盘只读存储器(CD-ROM)、光存储器件、磁存储器件、或者上述的任意合适的组合。在本公开中，计算机可读存储介质可以是任何包含或存储程序的有形介质，该程序可以被指令执行系统、装置或者器件使用或者与其结合使用。而在本公开中，计算机可读信号介质可以包括在基带中或者作为载波一部分传播的数据信号，其中承载了计算机可读的程序代码。这种传播的数据信号可以采用多种形式，包括但不限于电磁信号、光信号或上述的任意合适的组合。计算机可读信号介质还可以是计算机可读存储介质以外的任何计算机可读介质，该计算机可读信号介质可以发送、传播或者传输用于由指令执行系统、装置或者器件使用或者与其结合使用的程序。计算机可读介质上包含的程序代码可以用任何适当的介质传输，包括但不限于：电线、光缆、RF(射频)等等，或者上述的任意合适的组合。
上述计算机可读介质可以是上述电子设备中所包含的；也可以是单独存在，而未装配入该电子设备中。
本申请另一实施例提供了一种计算机程序产品,当该计算机程序产品被执行时，其用于执行上述任一项所述的接口文档的集成方法。
特别地，根据本公开的实施例，上文参考流程图描述的过程可以被实现为计算机软件程序。例如，本公开的实施例包括一种计算机程序产品，其包括承载在非暂态计算机可读介质上的计算机程序，该计算机程序包含用于执行流程图所示的方法的程序代码。在这样的实施例中，该计算机程序可以通过通信装置从网络上被下载和安装，或者从存储装置被安装，或者从ROM被安装。在该计算机程序被处理装置执行时，执行本公开实施例的方法中限定的上述功能。
尽管已经采用特定于结构特征和/或方法逻辑动作的语言描述了本主题，但是应当理解所附权利要求书中所限定的主题未必局限于上面描述的特定特征或动作。相反，上面所描述的特定特征和动作仅仅是实现权利要求书的示例形式。
虽然在上面论述中包含了若干具体实现细节，但是这些不应当被解释为对本公开的范围的限制。在单独的实施例的上下文中描述的某些特征还可以组合地实现在单个实施例中。相反地，在单个实施例的上下文中描述的各种特征也可以单独地或以任何合适的子组合的方式实现在多个实施例中。
以上描述仅为本公开的较佳实施例以及对所运用技术原理的说明。本领域技术人员应当理解，本公开中所涉及的公开范围，并不限于上述技术特征的特定组合而成的技术方案，同时也应涵盖在不脱离上述公开构思的情况下，由上述技术特征或其等同特征进行任意组合而形成的其它技术方案。例如上述特征与本公开中公开的(但不限于)具有类似功能的技术特征进行互相替换而形成的技术方案。
Claims (10)
1.一种接口文档的集成方法，其特征在于，包括：
当网关服务启动时，确定需要网关代理的每一个目标服务；其中，所述目标服务包括：业务服务和网关服务；
获取所述需要网关代理的每一个目标服务对应的接口文档；
对所述需要网关代理的每一个目标服务对应的接口文档进行集成，得到接口文档集合。
2.根据权利要求1所述的集成方法，其特征在于，一个所述目标服务对应的接口文档的生成方法，包括：
获取所述目标服务的文档支持包；
利用所述文档支持包中的数据，配置所述目标服务的文档参数；
为配置文档参数后的所述目标服务的每个接口，添加所述接口对应的说明信息，得到所述目标服务对应的接口文档。
3.根据权利要求1所述的集成方法，其特征在于，所述对所述需要网关代理的每一个目标服务对应的接口文档进行集成，得到接口文档集合，包括：
将每一个所述目标服务对应的接口文档的路径信息进行集合，得到最终的文档对象；
利用所述最终的文档对象覆盖所述网关的文档对象，得到所述接口文档集合。
4.根据权利要求1所述的集成方法，其特征在于，所述对所述需要网关代理的每一个目标服务对应的接口文档进行集成，得到接口文档集合之后，还包括：
根据所述接口文档集合，生成UI界面。
5.根据权利要求2所述的集成方法，其特征在于，所述文档支持包提供gradle版本或maven版本的集成支持。
6.一种接口文档的集成装置，其特征在于，包括：
确定单元，用于当网关服务启动时，确定需要网关代理的每一个目标服务；其中，所述目标服务包括：业务服务和网关服务；
第一获取单元，用于获取所述需要网关代理的每一个目标服务对应的接口文档；
集成单元，用于对所述需要网关代理的每一个目标服务对应的接口文档进行集成，得到接口文档集合。
7.根据权利要求6所述的集成装置，其特征在于，一个所述目标服务对应的接口文档的生成单元，包括：
第二获取单元，用于获取所述目标服务的文档支持包；
配置单元，用于利用所述文档支持包中的数据，配置所述目标服务的文档参数；
添加单元，用于为配置文档参数后的所述目标服务的每个接口，添加所述接口对应的说明信息，得到所述目标服务对应的接口文档。
8.根据权利要求6所述的集成装置，其特征在于，所述集成单元，包括：
集合单元，用于将每一个所述目标服务对应的接口文档的路径信息进行集合，得到最终的文档对象；
覆盖单元，用于利用所述最终的文档对象覆盖所述网关的文档对象，得到所述接口文档集合。
9.一种服务器，其特征在于，包括：
一个或多个处理器；
存储装置，其上存储有一个或多个程序；
当所述一个或多个程序被所述一个或多个处理器执行时，使得所述一个或多个处理器实现如权利要求1至5中任一所述的方法。
10.一种计算机存储介质，其特征在于，其上存储有计算机程序，其中，所述计算机程序被处理器执行时实现如权利要求1至5中任一所述的方法。
Priority Applications (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202011084630.3A CN112230891A (zh) | 2020-10-12 | 2020-10-12 | 接口文档的集成方法、装置、服务器及计算机存储介质 |
Applications Claiming Priority (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202011084630.3A CN112230891A (zh) | 2020-10-12 | 2020-10-12 | 接口文档的集成方法、装置、服务器及计算机存储介质 |
Publications (1)
| Publication Number | Publication Date |
|---|---|
| CN112230891A true CN112230891A (zh) | 2021-01-15 |
Family
ID=74112150
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| CN202011084630.3A Pending CN112230891A (zh) | 2020-10-12 | 2020-10-12 | 接口文档的集成方法、装置、服务器及计算机存储介质 |
Country Status (1)
| Country | Link |
|---|---|
| CN (1) | CN112230891A (zh) |
Cited By (1)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN113094139A (zh) * | 2021-04-20 | 2021-07-09 | 北京沃东天骏信息技术有限公司 | Ui样式更新方法和装置 |
Citations (5)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN110321154A (zh) * | 2019-06-25 | 2019-10-11 | 北京奇艺世纪科技有限公司 | 一种微服务的接口信息展示方法、装置及电子设备 |
| US20200042316A1 (en) * | 2018-07-31 | 2020-02-06 | Dell Products L.P. | Generating unified and dynamically updatable application programming interface documentation from different sources |
| CN110806863A (zh) * | 2019-11-05 | 2020-02-18 | 泰康保险集团股份有限公司 | 接口文档生成方法及装置、电子设备、存储介质 |
| CN110941950A (zh) * | 2019-11-26 | 2020-03-31 | 北京明略软件系统有限公司 | 接口文档的生成方法、装置、服务器及存储介质 |
| CN111258627A (zh) * | 2020-01-14 | 2020-06-09 | 中国建设银行股份有限公司 | 一种接口文档生成方法和装置 |
-
2020
- 2020-10-12 CN CN202011084630.3A patent/CN112230891A/zh active Pending
Patent Citations (5)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| US20200042316A1 (en) * | 2018-07-31 | 2020-02-06 | Dell Products L.P. | Generating unified and dynamically updatable application programming interface documentation from different sources |
| CN110321154A (zh) * | 2019-06-25 | 2019-10-11 | 北京奇艺世纪科技有限公司 | 一种微服务的接口信息展示方法、装置及电子设备 |
| CN110806863A (zh) * | 2019-11-05 | 2020-02-18 | 泰康保险集团股份有限公司 | 接口文档生成方法及装置、电子设备、存储介质 |
| CN110941950A (zh) * | 2019-11-26 | 2020-03-31 | 北京明略软件系统有限公司 | 接口文档的生成方法、装置、服务器及存储介质 |
| CN111258627A (zh) * | 2020-01-14 | 2020-06-09 | 中国建设银行股份有限公司 | 一种接口文档生成方法和装置 |
Non-Patent Citations (1)
| Title |
|---|
| 课工场成都基地: "有了Swagger2 再也不用担心API文档的维护了", pages 1 - 6, Retrieved from the Internet <URL:https://www.bilibili.com/read/cv7109558/> * |
Cited By (2)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN113094139A (zh) * | 2021-04-20 | 2021-07-09 | 北京沃东天骏信息技术有限公司 | Ui样式更新方法和装置 |
| CN113094139B (zh) * | 2021-04-20 | 2024-04-19 | 北京沃东天骏信息技术有限公司 | Ui样式更新方法和装置 |
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| CN113987074A (zh) | 分布式服务全链路监控方法、装置、电子设备及存储介质 | |
| CN111324342B (zh) | 一种生成接口层代码的方法、装置、介质和电子设备 | |
| CN111600772B (zh) | 网络分发内容检测处理装置、方法、系统及电子设备 | |
| US11502899B2 (en) | Dynamic product installation based on user feedback | |
| CN113505302A (zh) | 支持动态获取埋点数据的方法、装置、系统及电子设备 | |
| CN111309304B (zh) | 一种生成idl文件的方法、装置、介质和电子设备 | |
| CN113821352A (zh) | 一种远程服务的调用方法和装置 | |
| CN112230891A (zh) | 接口文档的集成方法、装置、服务器及计算机存储介质 | |
| CN113721910A (zh) | 界面代码生成方法、装置、电子设备和计算机可读介质 | |
| CN111612434A (zh) | 用于生成处理流程的方法、装置、电子设备和介质 | |
| CN116860286A (zh) | 页面动态更新方法、装置、电子设备和计算机可读介质 | |
| CN111414154A (zh) | 前端开发的方法、装置、电子设备和存储介质 | |
| CN115102992A (zh) | 数据发布方法、装置、电子设备和计算机可读介质 | |
| CN112783903B (zh) | 生成更新日志的方法和装置 | |
| CN113468342A (zh) | 基于知识图谱的数据模型构建方法、装置、设备和介质 | |
| CN112099841A (zh) | 一种生成配置文件的方法和系统 | |
| CN109271310B (zh) | 移动应用程序网络功能的开发测试方法和装置 | |
| CN113132447A (zh) | 反向代理的方法和系统 | |
| CN112988528B (zh) | 日志处理方法、装置及容器组 | |
| CN115062022B (zh) | 航空器手册拆分方法、装置、电子设备和计算机可读介质 | |
| CN110968768B (zh) | 信息生成方法和装置 | |
| CN115842819A (zh) | 自动驾驶系统测试数据下载方法、装置、设备 | |
| CN117424896A (zh) | 一种物联网设备的信息展示方法、装置、设备及介质 | |
| CN118069012A (zh) | 轮播图显示方法、装置、电子设备和计算机可读介质 | |
| CN112579427A (zh) | 生成虚拟化测试代码的方法和装置 |
Legal Events
| Date | Code | Title | Description |
|---|---|---|---|
| PB01 | Publication | ||
| PB01 | Publication | ||
| SE01 | Entry into force of request for substantive examination | ||
| SE01 | Entry into force of request for substantive examination |