CN110308930A - 接口文档生成方法、装置、计算机设备和存储介质 - Google Patents
接口文档生成方法、装置、计算机设备和存储介质 Download PDFInfo
- Publication number
- CN110308930A CN110308930A CN201910528724.6A CN201910528724A CN110308930A CN 110308930 A CN110308930 A CN 110308930A CN 201910528724 A CN201910528724 A CN 201910528724A CN 110308930 A CN110308930 A CN 110308930A
- Authority
- CN
- China
- Prior art keywords
- interface
- document
- source code
- parameters
- 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 80
- 230000005540 biological transmission Effects 0.000 claims description 5
- 241000208340 Araliaceae Species 0.000 claims description 3
- 235000005035 Panax pseudoginseng ssp. pseudoginseng Nutrition 0.000 claims description 3
- 235000003140 Panax quinquefolius Nutrition 0.000 claims description 3
- 239000000284 extract Substances 0.000 claims description 3
- 235000008434 ginseng Nutrition 0.000 claims description 3
- 230000004044 response Effects 0.000 abstract description 6
- 239000004744 fabric Substances 0.000 abstract description 4
- 230000000875 corresponding effect Effects 0.000 description 40
- 238000011161 development Methods 0.000 description 12
- 230000006870 function Effects 0.000 description 11
- 244000046052 Phaseolus vulgaris Species 0.000 description 7
- 235000010627 Phaseolus vulgaris Nutrition 0.000 description 7
- 238000010586 diagram Methods 0.000 description 6
- 238000007667 floating Methods 0.000 description 4
- 230000008569 process Effects 0.000 description 4
- 230000009286 beneficial effect Effects 0.000 description 3
- 238000004891 communication Methods 0.000 description 3
- 230000004048 modification Effects 0.000 description 3
- 238000012986 modification Methods 0.000 description 3
- 238000012360 testing method Methods 0.000 description 3
- 230000008901 benefit Effects 0.000 description 2
- 238000010276 construction Methods 0.000 description 2
- 238000005516 engineering process Methods 0.000 description 2
- 230000006399 behavior Effects 0.000 description 1
- 230000015572 biosynthetic process Effects 0.000 description 1
- 230000007812 deficiency Effects 0.000 description 1
- 238000005538 encapsulation Methods 0.000 description 1
- 230000003993 interaction Effects 0.000 description 1
- 239000000203 mixture Substances 0.000 description 1
- 238000010295 mobile communication Methods 0.000 description 1
- 239000003607 modifier Substances 0.000 description 1
- 238000012545 processing Methods 0.000 description 1
Classifications
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F16/00—Information retrieval; Database structures therefor; File system structures therefor
- G06F16/80—Information retrieval; Database structures therefor; File system structures therefor of semi-structured data, e.g. markup language structured data such as SGML, XML or HTML
- G06F16/81—Indexing, e.g. XML tags; Data structures therefor; Storage structures
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F8/00—Arrangements for software engineering
- G06F8/70—Software maintenance or management
- G06F8/73—Program documentation
Landscapes
- Engineering & Computer Science (AREA)
- Theoretical Computer Science (AREA)
- Software Systems (AREA)
- General Engineering & Computer Science (AREA)
- Physics & Mathematics (AREA)
- General Physics & Mathematics (AREA)
- Data Mining & Analysis (AREA)
- Databases & Information Systems (AREA)
- Library & Information Science (AREA)
- Document Processing Apparatus (AREA)
Abstract
本发明涉及一种接口文档生成方法、装置、计算机设备和存储介质。该方法通过接收并响应客户端发送的接口文档生成请求，获取客户端输入的目标项目的项目源代码，将项目源代码转换为源码树，解析源码树的各个节点，以获取各个功能模块包含的接口及其接口参数，并生成该目标项目的结构化接口文档，将接口文档返回至客户端，实现了接口文档的动态生成，提高了生成接口文档的效率和接口文档内容信息的准确率，提高了软件开发的效率。
Description
技术领域
本发明涉及软件开发技术领域，特别是涉及一种接口文档生成方法、装置、计算机设备和存储介质。
背景技术
在软件项目开发过程中，企业一般采用前后端分离的开发模式进行开发，即前端和后端开发人员对项目需求分解后并行进行开发，这种开发模式有利于大型软件系统的协作，从而提高开发速度。然而，这种开发模式需要前端开发人员、后端开发人员和测试人员之间的紧密沟通，如前端开发依赖于后端的接口数据，后端开发人员需要提供完善的接口文档给前端开发人员，以便于前端开发人员直接修改项目接口前缀，切换到对应的环境，进入项目提测。
现有技术中生成接口文档的方式为：在应用的开发过程中，将编写所涉及到的接口，在文档中写入该接口的各种属性、参数等接口说明，形成接口文档。当某一个接口所涉及的属性信息以及属性信息对应的属性参数进行修改时，则需要在接口文档中查找该对应的接口说明，并进行对应的修改。
然而，发明人在实践过程中发现现有技术至少存在以下问题：在接口开发过程中，接口文档的编写增加了开发时间，降低了测试效率，而且在接口更新或修改时，如果没有及时更新，导致后续的测试容易出错。
发明内容
本发明的目的旨在至少能解决上述的技术缺陷之一，特别是接口文档的编写增加了开发时间，降低了测试效率的技术问题。
第一方面，本发明实施例提供一种接口文档生成方法，所述方法包括：
接收客户端发送的接口文档生成请求；
响应所述接口文档生成请求，获取所述客户端输入的目标项目的项目源代码，并将所述项目源代码转换为源码树；
对所述源码树的各个节点进行解析，获取项目源代码各个功能模块包含的接口及其接口参数,根据所述接口参数生成所述目标项目的结构化的接口文档；
将所述接口文档返回至所述客户端。
在其中一个实施例中，所述对所述源码树的各个节点进行解析，获取项目源代码各个功能模块包含的接口及其接口参数,根据所述接口参数生成所述目标项目的结构化的接口文档的步骤，包括：
确定所述项目源代码的各个功能模块；
解析所述功能模块对应在源码树上的各个节点，得到所述功能模块的各个接口以及所述接口的接口协议和接口参数；
根据所述接口协议解析所述接口参数，确定所述接口参数的数据类型；
根据所述数据类型将所述接口参数生成结构化的接口文档。
在其中一个实施例中，所述解析所述功能模块对应在源码树上的各个节点，得到所述功能模块的各个接口以及所述接口的接口协议和接口参数的步骤，包括：
获取所述节点包含的接口标签；
根据所述接口标签确定所述节点中的接口类；
解析所述接口类，对所述接口类进行方法分析得到所述接口类中的方法集；
获取所述方法集中的接口，并提取所述接口所对应的接口协议和接口参数。
在其中一个实施例中，所述根据所述接口协议解析所述接口参数，确定所述接口参数的数据类型的步骤包括：
根据所述接口协议解析所述接口参数的第一属性信息；
根据所述第一属性信息判定所述接口参数的数据类型为基本数据类型或非基本数据类型。
在其中一个实施例中，若所述第一属性信息为基本数据类型；
所述根据所述数据类型将所述接口参数生成结构化的接口文档的步骤，包括：
解析所述接口参数得到第一数据信息；其中，所述第一数据信息包括名称、别名、数据类型、注释以及默认值中的至少一种；
将所述第一数据信息生成结构化的接口文档。
在其中一个实施例中，若所述第一属性信息为非基本数据类型；
所述根据所述数据类型将所述接口参数生成结构化的接口文档的步骤，包括：
解析所述接口参数的封装类型；
若所述封装类型为非闭环封装类型，解析所述接口参数的属性列表中的第二属性信息；
若所述第二属性信息为基本数据类型，解析所述接口参数得到第二数据信息；其中，所述第二数据信息包括名称、别名、数据类型、注释以及默认值中的至少一种；
将所述第二数据信息生成结构化的接口文档。
在其中一个实施例中，所述根据所述接口参数生成所述目标项目的结构化的接口文档的步骤之后，还包括：
为所述目标项目添加项目标识，对各功能模块添加功能模块标识；
获取所述功能模块的分支标识，并生成所述功能模块的各个接口的统一资源标识符；
将所述项目标识、功能模块标识、分支标识以及统一资源标识符进行关联，生成所述目标项目中接口所对应的接口标识，将所述接口标识作为所述接口文档的唯一标识。
在其中一个实施例中，所述将所述接口文档返回至所述客户端的步骤，包括：
将所述接口文档生成HTML格式的接口文档页面，将所述接口文档页面返回至所述客户端。
第二方面，本发明实施例还提供了一种接口文档生成装置，包括：
请求模块，用于接收客户端发送的接口文档生成请求；
响应模块，用于响应所述接口文档生成请求，获取所述客户端输入的目标项目的项目源代码，并将所述项目源代码转换为源码树；
生成模块，用于对所述源码树的各个节点进行解析，获取项目源代码各个功能模块包含的接口及其接口参数,根据所述接口参数生成所述目标项目的结构化的接口文档；
返回模块，用于将所述接口文档返回至所述客户端。
第三方面，本发明实施例还提供了一种计算机设备，包括：
一个或多个处理器；
存储器；
一个或多个应用程序，其中所述一个或多个应用程序被存储在所述存储器中并被配置为由所述一个或多个处理器执行，所述一个或多个程序配置用于执行所述程序时实现如第一方面所述的接口文档生成方法。
第四方面，本发明实施例还提供了一种包含计算机可执行指令的存储介质，所述计算机可执行指令在由计算机处理器执行时用于执行如第一方面所述的接口文档生成方法。
上述实施例提供的接口文档生成方法、装置、计算机设备和存储介质的技术方案，通过接收并响应客户端发送的接口文档生成请求，获取客户端输入的目标项目的项目源代码，将项目源代码转换为源码树，解析源码树的各个节点，以获取各个功能模块包含的接口及其接口参数，并生成该目标项目的结构化接口文档，将接口文档返回至客户端。该技术方案，实现了接口文档的动态生成，提高了生成接口文档的效率，并能够提升接口文档内容信息的准确率，提高了软件开发的效率。
本发明附加的方面和优点将在下面的描述中部分给出，这些将从下面的描述中变得明显，或通过本发明的实践了解到。
附图说明
本发明上述的和/或附加的方面和优点从下面结合附图对实施例的描述中将变得明显和容易理解，其中：
图1是一实施例提供的一种接口文档生成方法的流程图；
图2是一实施例步骤S130的详细流程图；
图3是一实施例的接口文档页面的显示界面示意图；
图4是一实施例步骤S132的详细流程图；
图5是一实施例步骤S133的详细流程图；
图6是一实施例提供的一种接口文档生成方法的工作流程示意图；
图7是一实施例提供的一种接口文档生成装置的结构示意图。
具体实施方式
下面详细描述本发明的实施例，所述实施例的示例在附图中示出，其中自始至终相同或类似的标号表示相同或类似的元件或具有相同或类似功能的元件。下面通过参考附图描述的实施例是示例性的，仅用于解释本发明，而不能解释为对本发明的限制。
本技术领域技术人员可以理解，除非特意声明，这里使用的单数形式“一”、“一个”、“所述”和“该”也可包括复数形式。应该进一步理解的是，本发明的说明书中使用的措辞“包括”是指存在所述特征、整数、步骤和/或操作，但是并不排除存在或添加一个或多个其他特征、整数、步骤和/或操作。这里使用的措辞“和/或”包括一个或更多个相关联的列出项的全部或任一单元和全部组合。
本技术领域技术人员可以理解，除非另外定义，这里使用的所有术语(包括技术术语和科学术语)，具有与本发明所属领域中的普通技术人员的一般理解相同的意义。还应该理解的是，诸如通用字典中定义的那些术语，应该被理解为具有与现有技术的上下文中的意义一致的意义，并且除非像这里一样被特定定义，否则不会用理想化或过于正式的含义来解释。
图1是一实施例提供的一种接口文档生成方法的流程图。本实施例提供的接口文档的生成方法由服务器端的计算机设备来执行，其中该计算机设备可由软件和/或硬件来实现。
本技术领域技术人员可以理解，这里服务器端所使用的计算机设备，其包括但不限于计算机、网络主机、单个网络服务器、多个网络服务器集或多个服务器构成的云。在此，云由基于云计算(Cloud Computing)的大量计算机或网络服务器构成。本发明的实施例中，服务器端与客户端之间可通过任何通讯方式实现通讯，包括但不限于，基于3GPP、LTE、WIMAX的移动通讯、基于TCP/IP、UDP协议的计算机网络通讯。
进一步的，服务器与至少一个客户端发生数据交互时，向服务器输入项目源代码以使服务器对项目源代码进行数据处理，一般而言，客户端可以有一个或者多个。
可选的，服务器安装有Javaparser解析器，该Javaparser解析器可以预先安装在服务器中，也可以是在服务器启动接口文档生成时，从第三方设备或另一服务器进行下载并安装使用。其中，第三方设备在实施例中不作限定。
如图1所示，该接口文档的生成方法包括如下步骤：
S110、接收客户端发送的接口文档生成请求。
其中，本实施例的实施方案可以部署在服务器上，用户可以通过web网页或者专用客户端向服务器发送接口文档生成请求，服务器接收接口文档生成请求并进行响应。
S120、响应所述接口文档生成请求，获取所述客户端输入的目标项目的项目源代码，并将所述项目源代码转换为源码树。
在本实施例中，目标项目是指需要进行生成接口文档的源代码项目，为了便于区别，可以为目标项目设定项目标识，如proIndex。
在服务器响应客户端的接口文档生成请求后，客户端可以在服务器提供的接口输入目标项目的项目源代码，服务器接收项目源代码，并将项目源代码转换为源码树。
在将所述项目源代码转换为源码树后，源码树的各个节点对应为源代码的功能模块，功能模块是项目源代码中按照所实现功能对源代码进行划分成的一个或多个模块。对应于源码树的各个节点，各个功能模块之间通过接口进行连接，在功能模块之间按照接口类型选择对应的接口协议进行数据的传输。
在一个实施例中，可以将项目源代码存储在指定目录位置，通过Javaparser解析器对项目源代码的源代码结构进行解析，将项目源代码转换为源码树，以便于对目标项目下的所有类进行分析，查找出目标项目下的类名、方法名信息等。
S130、对所述源码树的各个节点进行解析，获取项目源代码各个功能模块包含的接口及其接口参数,根据所述接口参数生成所述目标项目的结构化的接口文档。
本实施例中，对所述源码树的各个节点进行解析，即实现对各个功能模块的解析，从而获取项目源代码各个功能模块包含的接口及其接口参数,接口参数主要是输入参数和输出参数，利用接口参数生成接口文档。
由于源代码的每个功能模块中包括一个或多个接口，每个接口中包含有各接口的属性信息、名称、描述、统一资源标识符、输入参数、输出参数、协议类型等。通过分析可以提取到开发应用时所适用的接口及其对应的各种属性信息，以及属性信息对应的属性参数，如数据类型、默认值和注释等。
在实施例中，在生成接口文档时，可以通过以“项目-模块-接口-接口参数”关系，对解析出的信息，如项目标识、功能模块标识、接口标识、接口参数及其属性信息等进行关系，生成结构化的接口文档。
在其中一个实施例中，如图2所示，图2是一实施例步骤S130的详细流程图。步骤S130的对所述源码树的各个节点进行解析，获取项目源代码各个功能模块包含的接口及其接口参数,根据所述接口参数生成所述目标项目的结构化的接口文档，可以进一步包括以下步骤：
S131、确定所述项目源代码的各个功能模块。
可以将获取到的项目源代码按照所需要实现的功能进行划分成多个功能模块。示例性的，可以为每个功能模块添加功能模块标识(moduleName)，以便于区分开每个功能模块。
在一实施例中，由于功能模块项目源代码的开发阶段的版本的分支，因此也可以为每个分支添加分支标识(brancheName)。
S132、解析所述功能模块对应在源码树上的各个节点，得到所述功能模块的各个接口以及所述接口的接口协议和接口参数。
利用功能模块和源码树上的各个节点存在对应关系，解析功能模块对应在源码树上的各个节点，可以得到功能模块中的接口信息，如接口名称、数据类型、属性参数、接口协议、注释等。
在本步骤中，通过解析源码树的每一个节点，可以获取项目源代码中的语法结构，如包、类型、修饰符、运算符、接口、返回值甚至代码注释等，以及获取每个源码树的节点对应的具体的类。为了获得功能模块的接口信息，可以先对源码树的类进行解析，判断该类是否为接口类，解析该类，得到类里面的方法集，判断方法集中的方法是否为接口，进而获得该接口的接口协议和接口参数等。
S133、根据所述接口协议解析所述接口参数，确定所述接口参数的数据类型。
由于接口协议的类型不同，解析该接口的接口参数所采用的方式不同。根据接口协议的类型确定解析该接口参数的方式，判断接口参数的数据类型，如字符串、数字、集合以及自定义封装类型等。
S134、根据所述数据类型将所述接口参数生成结构化的接口文档。
本步骤中，根据数据类型，将解析得到接口参数生成由目标项目、功能模块、接口和接口参数等自上而下的逻辑结构组成的结构化的接口文档。
在实施例中，对于接口参数的数据类型是基本数据类型，如字符串类型，则将接口参数中的数据信息用于生成结构化的接口文档。
S140、将所述接口文档返回至所述客户端。
在本步骤中，服务器可以将接口文档返回至客户端，作为实施例，可以将接口文档生成HTML格式的接口文档页面，将接口文档页面返回至所述客户端，并通过客户端查看接口文档信息。参考图3所示，图3是一实施例的接口文档页面的显示界面示意图。接口文档页面上显示接口对应的方法别名(name)、数据类型(type)、描述(description)以及返回结果等信息。
一般而言，接口文档还可以以其他形式来呈现，如WORD文档，TXT文档等，根据实际需要设定接口文档呈现的模板格式，使得接口文档更加个性化。
上述步骤中，客户端通过显示界面显示接口文档中的信息，用户只需要上传项目源代码，即可以由服务器自动生成并返回接口文档。
本实施例提供的技术方案，通过接收并响应客户端发送的接口文档生成请求，获取客户端输入的目标项目的项目源代码，将项目源代码转换为源码树，解析源码树的各个节点，以获取各个功能模块包含的接口及其接口参数，并生成该目标项目的结构化接口文档，将接口文档返回至客户端，实现了项目源代码中的接口文档的自动生成，不需要人工进行编写，提高了接口文档生成效率，并能够提升接口文档内容信息的准确率，提高了软件开发的效率。
在其中一个实施例中，在步骤S130所述根据所述接口参数生成所述目标项目的结构化的接口文档之后，还包括：
S1301、为所述目标项目添加项目标识，对各功能模块添加功能模块标识。
为目标项目添加项目标识，将该项目标识作为该目标项目有唯一标识，示例性的，将目标项目添加唯一标识名称：proIndex。为各功能模块添加功能模块标识，将功能模块标识作为该功能模块的唯一标识，示例性的，将功能模块添加唯一标识：moduleName。
S1302、获取所述功能模块的分支标识，并生成所述功能模块的各个接口的统一资源标识符。
各功能模块有各自的分支，并为各分支添加分支标识：branchName，通过分支标识可以快速查找到项目源代码开发的不同开发阶段的版本。同时生成各个功能模块中的各个接口的统一资源标识符(Uniform Resource Identifier,URI)，URI是用于唯一地标识元素或属性的数字或名称，URI包含的信息指出该功能接口所在的位置和命名信息。实施例中，URI用于唯一地标识各个接口的名称。通过URI可以快速查找到功能模块的各个接口。URI指向客户端所请求生成接口文档的接口。
S1303、将所述项目标识、功能模块标识、分支标识以及统一资源标识符进行关联，生成所述目标项目中接口所对应的接口标识，将所述接口标识作为所述接口文档的唯一标识。
将项目标识、功能模块标识、分支标识以及统一资源标识符进行关联，按照设定的处理公式，生成目标项目中接口所对应的接口标识。在实施例中，通过处理公式：interfaceKey＝MD5(proIndex+“_”+moduleName+“_”+brancheName+“_”+uri)，采用MD5信息摘要算法生成MD5摘要作为接口的唯一标识，其中，interfaceKey为接口所对应的接口标识，将该接口标识作为接口文档的唯一标识。其中，MD5信息摘要算法生成MD5摘要可以通过现有技术来实现，在此不做详细描述。
将项目标识、功能模块标识、分支标识以及统一资源标识符进行关联，生成目标项目中接口所对应的接口标识，将接口标识作为接口文档的唯一标识，便于根据接口标识寻找出请求生成接口文档对应的接口，提高软件开发效率。
下面将针对于以上实施例中涉及的若干方案做进一步阐述。
在其中一个实施例中，参考图4，图4是一实施例步骤S132的详细流程图；步骤S132的所述解析所述功能模块对应在源码树上的各个节点，得到所述功能模块的各个接口以及所述接口的接口协议和接口参数，可以包括以下步骤：
S401、获取所述节点包含的接口标签。
接口标签用于区分不同接口及其类型的标签。接口标签可以按照接口的类型、参数等信息的不同进行自行定义。如HTTP接口用@Control或@RestController等接口标签来定义。用户可以预设在节点中需要生成接口文档的接口添加相应的接口标签，服务器响应接口文档生成请求时，获取节点包含的接口标签，以获得节点中该接口标签所对应的类的信息。
S402、根据所述接口标签确定所述节点中的接口类。
节点中包含有多种类，不同的类，其对应的接口标签不同。在实施例中，可以预先指定某一种或多种的接口标签所对应的类为接口类。根据获取到的接口标签，根据接口标签的类型判断节点中包含的类是否为接口类，从而确定出接口类。
S403、解析所述接口类，对所述接口类进行方法分析得到所述接口类中的方法集。
该接口类的信息包括接口类的名称(name)、在项目的全路径(fullname)、描述(desc)和类里面的方法集(interface)等信息。确定节点中的接口类后，对接口类进行方法分析，解析出接口类中的方法集，其中，方法集中包含有一个或多个方法。
S404、获取所述方法集中的接口，并提取所述接口所对应的接口协议和接口参数。
获取方法集中的各个方法，可以通过各方法对应的接口标签的种类来判断该方法是否为接口。实施例中，获取该方法对应的接口标签，通过分析接口标签，判断该方法是否为接口。示例性的，如方法A对应的接口标签为M标签，M标签对应的是接口，则可以判定方法A为接口。
在本步骤中，确定该方法为接口时，解析该方法的信息，如方法别名(name)、方法名(id)、描述(desc)、统一资源标识符(URI)、接口参数、接口协议(protocolType)等，其中，接口参数包括输入参数(ReqBean)和输出参数(RespBean)。在实施例中，还可以通过协议自有特征，如特定的标识来进一步判断接口协议的类型，如HTTP接口所对应的协议有@RequestMapping标识，Thrift接口所对应的协议有org.apache.thrift.TBase标识等，其他接口协议可根据应用场景插拔式添加。
在其中一个实施例中，参考图5，图5是一实施例步骤S133的详细流程图，步骤S133中所述根据所述接口协议解析所述接口参数，确定所述接口参数的数据类型，可以包括：
S501、根据所述接口协议解析所述接口参数的第一属性信息。
接口参数中包含有多个第一属性信息，第一属性信息的类型包括基本数据类型和非基本数据类型，其中，非基本数据类型包括结构类型和集合类型等。
S502、根据所述第一属性信息判定所述接口参数的数据类型是否为基本数据类型，若是，执行步骤S503，若否，执行步骤S505。
基本数据类型是指Java的基本数据类型，可以分为整数类型、浮点类型、字符类型和布尔类型这四个类型，整数类型变量用来表示整数的数据类型。整数类型又分为字节型(byte)、短整型(short)、整型(int)、长整型(long)这四种。浮点类型用来表示小数的数据类型。浮点类型分为float(单精度型)和double(双精度类型)。字符类型的关键字是“char”。布尔类型是表示逻辑值的基本数据类型。非基本数据类型包括结构类型和集合类型等，根据所述第一属性信息判定所述接口参数的数据类型是基本数据类型或非基本数据类型。
对于判断的方法，若解析出接口参数的第一属性信息为整数类型、浮点类型、字符类型和布尔类型中的一种，则判定接口参数的数据类型为基本数据类型，反之，则为非基本数据类型。
S503、解析所述接口参数得到第一数据信息。
其中，第一数据信息包括名称、别名、数据类型、注释以及默认值中的至少一种。当接口参数为基本数据类型时，解析出接口参数的第一数据信息，包括名称、别名、数据类型、注释、默认值等信息。第一数据信息用于生成接口文档，即将第一数据信息添加到接口文档中。
S504、将所述第一数据信息生成结构化的接口文档。
将第一数据信息按照预定的格式生成接口文档，构成“目标项目-功能模块-接口-接口参数”关系，形成结构化数据，存储起来。
S505、解析所述接口参数的封装类型。
当接口参数为非基本数据类型时，获取接口参数的封装类型，解析其封装类型。
S506、判断封装类型是否为闭环封装类型，若是，执行步骤S507，若否，返回执行步骤S508。
S507、将所述接口参数标识为未解决类型。
当判断接口参数的封装类型为闭环类型，则将接口参数标识为未解决类型，如闭环类型属性，并引用正在解析的自身类型，跳出解析，待解析完整个输入参数或输出参数后，通过引用获取到闭环类型属性，以免死循环解析。
S508、解析出属性列表，遍历递归解析属性列表中的各第二属性信息，确定数据类型为基本数据类型的第二属性信息。
若接口参数的封装类型不是闭环封装类型，对该封装类型进行解析出相关的属性列表，再解析属性列表中各第二属性信息。可选的，采用递归解析的方式解析属性列表中的每个第二属性信息。第二属性信息的数据类型包括基本数据类型、结构类型和集合类型等。从各第二属性信息中确定数据类型为基本数据类型的第二属性信息，进一步解析出数据类型、注释、默认值等信息。将数据类型、注释、默认值等信息生成结构化的接口文档。
图6是一实施例提供的一种接口文档生成方法的工作流程示意图。为了更加清晰本发明实施例提供的技术方案，下面结合附图6阐述接口文档生成方法流程的示例。
S601、获取项目源代码。
具体的，通过各种方式获取项目中的项目源代码，把项目源代码存储在Tagee系统指定目录位置。
S602、解析项目源代码，得到源码树。
通过Javaparser解析器解析该项目源代码的结构，形成源码树，并将源码树命名为Tree，且每个项目有一个全服唯一标识名称：proIndex。根据项目源代码，指定生成接口文档的功能模块名称(moduleName)及分支名称(brancheName)，分支是指代码的开发阶段的版本。
S603、对源码树逐个节点进行分析。
对源码树逐个节点进行分析，以确定每个节点中是否有需要生成接口文档的接口。示例性的，需要生成接口文档的接口上添加接口标签，以便于在这个分析节点时快速查找出需要生成接口文档的接口。
S604、判断接口是否需要生成接口文档，若是，执行S606，否则执行S605。
添加有接口标签的接口需要生成接口文档，没有添加接口标签的接口不需要生成接口文档。
S605、缓存接口数据。
检测到当前接口没有添加用于指定生成接口文档的接口标签，则将该接口对应的接口数据缓存起来，用于后续对接口数据进行Bean封装类型的解析。
S606、分析JavaDoc标签和Tagee定义标签。
本实施例中的接口标签包括两类：JavaDoc标签和Tagee定义标签。其中，JavaDoc标签是Java通用的标签，Tagee定义标签是Tagee系统自定义的标签，适用于Tagee系统。
JavaDoc标签和定义Tagee标签均用于为类、接口添加注释，也可为构造函数、值域、方法等类中的元素添加注释。若获取到的接口标签属于JavaDoc标签，则采用Java通用方式对接口标签进行解析，判断该接口标签对应的接口是否需要生成接口文档，若获取到的接口标签属于Tagee定义标签，则采用适合于Tagee系统的方法对接口标签进行解析，判断该接口标签对应的接口是否需要生成接口文档。
在其他实施例中，可以通过为不需要生成接口文档的某些接口配置Tagee系统自定义的标签，如@TageeIgnore，也可以对解析出来的接口参数的某些属性信息配置自定义标签，如@TageeFieldIgnore，以进行标识，从不将该属性信息添加到接口文档中。其他功能标签可以根据自身业务进行添加，并根据该添加的功能标签配置相应的标签解析过程。
S607、判定接口对应的接口协议。
根据接口标签识别出接口类和接口后，利用协议自有特征判断出接口的接口协议，如HTTP接口有@RequestMapping接口标识，Thrift接口有org.apache.thrift.TBase接口标识等。
S608、解析接口参数，接口参数包括输入参数和输出参数。
S609、解析接口参数的属性信息。
S610、判断属性信息是否是基本数据类型，若是，则执行S611，否则执行S613。
S611、获取接口参数的数据类型、默认值、注释等信息。
S612、构造项目-功能模块-接口-接口参数关系，形成结构化数据，存储起来。
关联项目、功能模块、接口和接口参数等信息，生成结构化的接口文档，存储起来。
S613、解析封装类型Bean的属性。
接口参数的封装类型为Bean。Bean可以有多种属性，如name属性，parent属性等，不同的属性有不同的值。
S614、判断封装类型是否为闭环Bean；若是，则执行S615，否则返回S609。
由于对象的相互依赖关系，除非有终结条件，在闭环Bean中，循环调用为一个死循环。
S615、将接口参数标识为未解决类型。
若接口参数的属性信息是闭环封装类型，则表示此属性为闭环Bean类型，并引用正在解析的自身类型，然后跳过解析，待解析整个输入参数或输出参数，通过引用获取到闭环类型属性，以避免死循环解析。
S616、结束。
图7是一实施例提供的一种接口文档生成装置的结构示意图，如图7所示，本实施例提供的接口文档生成装置可以集成在计算机设备中，该计算机设备可以是服务器等。参考图7，本实施例提供的接口文档生成装置具体包括：请求模块710、响应模块720、生成模块730和返回模块740。
其中，请求模块710，用于接收客户端发送的接口文档生成请求；响应模块720，用于响应所述接口文档生成请求，获取所述客户端输入的目标项目的项目源代码，并将所述项目源代码转换为源码树；生成模块730，用于对所述源码树的各个节点进行解析，获取项目源代码各个功能模块包含的接口及其接口参数,根据所述接口参数生成所述目标项目的结构化的接口文档；返回模块740，用于将所述接口文档返回至所述客户端。
本实施例提供的技术方案，通过获取客户端输入的目标项目的项目源代码，将项目源代码转换为源码树，解析源码树的各个节点，以获取各个功能模块包含的接口及其接口参数，并生成该目标项目的结构化接口文档，将接口文档返回至客户端，不需要人工编写接口文档，实现了接口文档的动态生成，提高了生成接口文档的效率和接口文档内容信息的准确率，提高了软件开发的效率。
在其中一个实施例中，生成模块730包括：功能模块确定单元，用于确定所述项目源代码的各个功能模块；接口参数获取单元，用于解析所述功能模块对应在源码树上的各个节点，得到所述功能模块的各个接口以及所述接口的接口协议和接口参数；数据类型确定单元，用于根据所述接口协议解析所述接口参数，确定所述接口参数的数据类型；接口文档生成单元，用于根据所述数据类型将所述接口参数生成结构化的接口文档。
在其中一个实施例中，接口参数获取单元包括：接口标签获取子单元，用于获取所述节点包含的接口标签；接口类确定子单元，用于根据所述接口标签确定所述节点中的接口类；方法集获取子单元，用于解析所述接口类，对所述接口类进行方法分析得到所述接口类中的方法集；接口参数获取子单元，用于获取所述方法集中的接口，并提取所述接口所对应的接口协议和接口参数。
在其中一个实施例中，数据类型确定单元包括：属性信息解析子单元，用于根据所述接口协议解析所述接口参数的第一属性信息；数据类型判定子单元，用于根据所述第一属性信息判定所述接口参数的数据类型为基本数据类型或非基本数据类型。
在其中一个实施例中，若所述第一属性信息为基本数据类型时，接口文档生成单元包括：第一数据信息解析子单元，用于解析所述接口参数得到第一数据信息；其中，所述第一数据信息包括名称、别名、数据类型、注释以及默认值中的至少一种；第一接口文档生成子单元，用于将所述第一数据信息生成结构化的接口文档。
在其中一个实施例中，若所述第一属性信息为非基本数据类型；接口文档生成单元包括：封装类型解析子单元，用于解析所述接口参数的封装类型；非闭环封装解析子单元，用于若所述封装类型为非闭环封装类型，解析所述接口参数的属性列表中的第二属性信息；第二数据信息解析子单元，用于若所述第二属性信息为基本数据类型，解析所述接口参数得到第二数据信息；其中，所述第二数据信息包括名称、别名、数据类型、注释以及默认值中的至少一种；第一接口文档生成子单元，用于将所述第二数据信息生成结构化的接口文档。
在其中一个实施例中，该接口文档生成装置包括：标识添加模块，用于为所述目标项目添加项目标识，对各功能模块添加功能模块标识；标识获取模块，用于获取所述功能模块的分支标识，并生成所述功能模块的各个接口的统一资源标识符；接口标识生成模块，用于将所述项目标识、功能模块标识、分支标识以及统一资源标识符进行关联，生成所述目标项目中接口所对应的接口标识，将所述接口标识作为所述接口文档的唯一标识。
在其中一个实施例中，返回模块包括文档页面生成单元，用于将所述接口文档生成HTML格式的接口文档页面，将所述接口文档页面返回至所述客户端。
本实施例提供的接口文档生成装置可用于执行上述任意实施例提供的接口文档生成方法，且具备相应的功能和有益效果。
本发明实施例还提供了一种计算机设备，包括：一个或多个处理器；存储器；一个或多个应用程序，其中所述一个或多个应用程序被存储在所述存储器中并被配置为由所述一个或多个处理器执行，所述一个或多个程序配置用于执行所述程序时实现上述任一实施例提及的接口文档生成方法。
上述提供的计算机设备可用于执行上述任意实施例提供的接口文档生成方法，具备相应的功能和有益效果。
本发明实施例还提供一种包含计算机可执行指令的存储介质，所述计算机可执行指令在由计算机处理器执行时用于执行一种接口文档生成方法，包括：
接收客户端发送的接口文档生成请求；
响应所述接口文档生成请求，获取所述客户端输入的目标项目的项目源代码，并将所述项目源代码转换为源码树；
对所述源码树的各个节点进行解析，获取项目源代码各个功能模块包含的接口及其接口参数,根据所述接口参数生成所述目标项目的结构化的接口文档；
将所述接口文档返回至所述客户端。当然，本发明实施例所提供的一种包含计算机可执行指令的存储介质,其计算机可执行指令不限于如上所述的接口文档生成方法操作，还可以执行本发明任意实施例所提供的接口文档生成方法中的相关操作，且具备相应的功能和有益效果。
通过以上关于实施方式的描述，所属领域的技术人员可以清楚地了解到，本发明可借助软件及必需的通用硬件来实现，当然也可以通过硬件实现，但很多情况下前者是更佳的实施方式。基于这样的理解，本发明的技术方案本质上或者说对现有技术做出贡献的部分可以以软件产品的形式体现出来，该计算机软件产品可以存储在计算机可读存储介质中，如计算机的软盘、只读存储器(Read-Only Memory,ROM)、随机存取存储器(RandomAccess Memory,RAM)、闪存(FLASH)、硬盘或光盘等，包括若干指令用以使得一台计算机设备(可以是机器人，个人计算机，服务器，或者网络设备等)执行本发明任意实施例所述的接口文档生成方法。
应该理解的是，虽然附图的流程图中的各个步骤按照箭头的指示依次显示，但是这些步骤并不是必然按照箭头指示的顺序依次执行。除非本文中有明确的说明，这些步骤的执行并没有严格的顺序限制，其可以以其他的顺序执行。而且，附图的流程图中的至少一部分步骤可以包括多个子步骤或者多个阶段，这些子步骤或者阶段并不必然是在同一时刻执行完成，而是可以在不同的时刻执行，其执行顺序也不必然是依次进行，而是可以与其他步骤或者其他步骤的子步骤或者阶段的至少一部分轮流或者交替地执行。
以上所述仅是本发明的部分实施方式，应当指出，对于本技术领域的普通技术人员来说，在不脱离本发明原理的前提下，还可以做出若干改进和润饰，这些改进和润饰也应视为本发明的保护范围。
Claims (11)
1.一种接口文档生成方法，其特征在于，所述方法包括：
接收客户端发送的接口文档生成请求；
响应所述接口文档生成请求，获取所述客户端输入的目标项目的项目源代码，并将所述项目源代码转换为源码树；
对所述源码树的各个节点进行解析，获取项目源代码各个功能模块包含的接口及其接口参数，根据所述接口参数生成所述目标项目的结构化的接口文档；
将所述接口文档返回至所述客户端。
2.根据权利要求1所述的接口文档生成方法，其特征在于，所述对所述源码树的各个节点进行解析，获取项目源代码各个功能模块包含的接口及其接口参数,根据所述接口参数生成所述目标项目的结构化的接口文档的步骤，包括：
确定所述项目源代码的各个功能模块；
解析所述功能模块对应在源码树上的各个节点，得到所述功能模块的各个接口以及所述接口的接口协议和接口参数；
根据所述接口协议解析所述接口参数，确定所述接口参数的数据类型；
根据所述数据类型将所述接口参数生成结构化的接口文档。
3.根据权利要求2所述的接口文档生成方法，其特征在于，所述解析所述功能模块对应在源码树上的各个节点，得到所述功能模块的各个接口以及所述接口的接口协议和接口参数的步骤，包括：
获取所述节点包含的接口标签；
根据所述接口标签确定所述节点中的接口类；
解析所述接口类，对所述接口类进行方法分析得到所述接口类中的方法集；
获取所述方法集中的接口，并提取所述接口所对应的接口协议和接口参数。
4.根据权利要求2所述的接口文档生成方法，其特征在于，所述根据所述接口协议解析所述接口参数，确定所述接口参数的数据类型的步骤包括：
根据所述接口协议解析所述接口参数的第一属性信息；
根据所述第一属性信息判定所述接口参数的数据类型为基本数据类型或非基本数据类型。
5.根据权利要求4所述的接口文档的生成方法，其特征在于，若所述第一属性信息为基本数据类型；
所述根据所述数据类型将所述接口参数生成结构化的接口文档的步骤，包括：
解析所述接口参数得到第一数据信息；其中，所述第一数据信息包括名称、别名、数据类型、注释以及默认值中的至少一种；
将所述第一数据信息生成结构化的接口文档。
6.根据权利要求5所述的接口文档生成方法，其特征在于，若所述第一属性信息为非基本数据类型；
所述根据所述数据类型将所述接口参数生成结构化的接口文档的步骤，包括：
解析所述接口参数的封装类型；
若所述封装类型为非闭环封装类型，解析所述接口参数的属性列表中的第二属性信息；
若所述第二属性信息为基本数据类型，解析所述接口参数得到第二数据信息；其中，所述第二数据信息包括名称、别名、数据类型、注释以及默认值中的至少一种；
将所述第二数据信息生成结构化的接口文档。
7.根据权利要求1所述的接口文档生成方法，其特征在于，所述根据所述接口参数生成所述目标项目的结构化的接口文档的步骤之后，还包括：
为所述目标项目添加项目标识，对各功能模块添加功能模块标识；
获取所述功能模块的分支标识，并生成所述功能模块的各个接口的统一资源标识符；
将所述项目标识、功能模块标识、分支标识以及统一资源标识符进行关联，生成所述目标项目中接口所对应的接口标识，将所述接口标识作为所述接口文档的唯一标识。
8.根据权利要求1所述的接口文档生成方法，其特征在于，所述将所述接口文档返回至所述客户端的步骤，包括：
将所述接口文档生成HTML格式的接口文档页面，将所述接口文档页面返回至所述客户端。
9.一种接口文档生成装置，其特征在于，包括：
请求模块，用于接收客户端发送的接口文档生成请求；
响应模块，用于响应所述接口文档生成请求，获取所述客户端输入的目标项目的项目源代码，并将所述项目源代码转换为源码树；
生成模块，用于对所述源码树的各个节点进行解析，获取项目源代码各个功能模块包含的接口及其接口参数,根据所述接口参数生成所述目标项目的结构化的接口文档；
返回模块，用于将所述接口文档返回至所述客户端。
10.一种计算机设备，其特征在于，其包括：
一个或多个处理器；
存储器；
一个或多个应用程序，其中所述一个或多个应用程序被存储在所述存储器中并被配置为由所述一个或多个处理器执行，所述一个或多个程序配置用于执行如权利要求1-8任一项所述的接口文档生成方法。
11.一种包含计算机可执行指令的存储介质，其特征在于，所述计算机可执行指令在由计算机处理器执行时用于执行如权利要求1-8任一项所述的接口文档生成方法。
Priority Applications (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN201910528724.6A CN110308930A (zh) | 2019-06-18 | 2019-06-18 | 接口文档生成方法、装置、计算机设备和存储介质 |
Applications Claiming Priority (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN201910528724.6A CN110308930A (zh) | 2019-06-18 | 2019-06-18 | 接口文档生成方法、装置、计算机设备和存储介质 |
Publications (1)
| Publication Number | Publication Date |
|---|---|
| CN110308930A true CN110308930A (zh) | 2019-10-08 |
Family
ID=68077734
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| CN201910528724.6A Pending CN110308930A (zh) | 2019-06-18 | 2019-06-18 | 接口文档生成方法、装置、计算机设备和存储介质 |
Country Status (1)
| Country | Link |
|---|---|
| CN (1) | CN110308930A (zh) |
Cited By (18)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN110825430A (zh) * | 2019-11-08 | 2020-02-21 | 政采云有限公司 | 一种api文档生成方法、装置、设备及存储介质 |
| CN110941950A (zh) * | 2019-11-26 | 2020-03-31 | 北京明略软件系统有限公司 | 接口文档的生成方法、装置、服务器及存储介质 |
| CN111190594A (zh) * | 2019-12-23 | 2020-05-22 | 北京健康之家科技有限公司 | Vue组件的文档生成方法及装置 |
| CN111240653A (zh) * | 2019-12-31 | 2020-06-05 | 瑞庭网络技术（上海）有限公司 | 接口文档生成方法、装置及可读存储介质 |
| CN111400219A (zh) * | 2020-03-15 | 2020-07-10 | 杭州卓健信息科技有限公司 | 接口适配器及其电子设备 |
| CN111414161A (zh) * | 2020-03-27 | 2020-07-14 | 北京字节跳动网络技术有限公司 | 一种生成idl文件的方法、装置、介质和电子设备 |
| CN111447279A (zh) * | 2020-03-27 | 2020-07-24 | 广州华多网络科技有限公司 | 服务器及接口解析服务包生成方法 |
| CN111507079A (zh) * | 2020-04-08 | 2020-08-07 | 杭州涂鸦信息技术有限公司 | 一种多语言文档生成方法及系统和设备 |
| CN111767096A (zh) * | 2020-06-29 | 2020-10-13 | 深圳前海微众银行股份有限公司 | 接口文档的生成方法、装置、设备及计算机可读存储介质 |
| CN111880778A (zh) * | 2020-06-30 | 2020-11-03 | 百度在线网络技术（北京）有限公司 | 接口文档的生成方法、装置、电子设备及存储介质 |
| CN112131293A (zh) * | 2020-09-21 | 2020-12-25 | 平安国际智慧城市科技股份有限公司 | 接口管理方法、装置、终端设备及存储介质 |
| CN112306549A (zh) * | 2020-10-30 | 2021-02-02 | 康键信息技术（深圳）有限公司 | 接口文档配置方法、装置、设备及存储介质 |
| CN112433753A (zh) * | 2020-11-25 | 2021-03-02 | 平安普惠企业管理有限公司 | 基于参数信息的接口文档生成方法、装置、设备和介质 |
| CN112667274A (zh) * | 2019-10-15 | 2021-04-16 | 北京地平线机器人技术研发有限公司 | 生成应用程序编程接口文档的方法、装置及电子设备 |
| CN112685078A (zh) * | 2020-12-30 | 2021-04-20 | 平安证券股份有限公司 | 接口文档生成与查询方法、装置及计算机可读存储介质 |
| CN113094093A (zh) * | 2021-03-29 | 2021-07-09 | 四川新网银行股份有限公司 | 一种基于互联网金融系统从源码生成系统交互的api文档的方法 |
| CN113419738A (zh) * | 2021-06-22 | 2021-09-21 | 未鲲(上海)科技服务有限公司 | 接口文档的生成方法、装置及接口管理设备 |
| CN116149882A (zh) * | 2023-04-19 | 2023-05-23 | 北京轻松筹信息技术有限公司 | 一种生成接口描述文件的方法、装置、设备和存储介质 |
Citations (5)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| US20140040863A1 (en) * | 2012-07-31 | 2014-02-06 | Vmware, Inc. | Documentation generation for web apis based on byte code analysis |
| CN107463376A (zh) * | 2017-07-21 | 2017-12-12 | 珠海牛角科技有限公司 | 基于Javadoc的自动生成后端接口文档的方法及装置 |
| CN108932122A (zh) * | 2018-06-19 | 2018-12-04 | 上海陆家嘴国际金融资产交易市场股份有限公司 | 接口文档生成方法、装置、计算机设备和存储介质 |
| CN109032663A (zh) * | 2018-07-09 | 2018-12-18 | 深圳市小牛在线互联网信息咨询有限公司 | 接口文档的生成方法、装置、计算机设备及存储介质 |
| CN109375922A (zh) * | 2018-09-26 | 2019-02-22 | 深圳壹账通智能科技有限公司 | 一种接口文档的自动生成方法及终端设备 |
-
2019
- 2019-06-18 CN CN201910528724.6A patent/CN110308930A/zh active Pending
Patent Citations (5)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| US20140040863A1 (en) * | 2012-07-31 | 2014-02-06 | Vmware, Inc. | Documentation generation for web apis based on byte code analysis |
| CN107463376A (zh) * | 2017-07-21 | 2017-12-12 | 珠海牛角科技有限公司 | 基于Javadoc的自动生成后端接口文档的方法及装置 |
| CN108932122A (zh) * | 2018-06-19 | 2018-12-04 | 上海陆家嘴国际金融资产交易市场股份有限公司 | 接口文档生成方法、装置、计算机设备和存储介质 |
| CN109032663A (zh) * | 2018-07-09 | 2018-12-18 | 深圳市小牛在线互联网信息咨询有限公司 | 接口文档的生成方法、装置、计算机设备及存储介质 |
| CN109375922A (zh) * | 2018-09-26 | 2019-02-22 | 深圳壹账通智能科技有限公司 | 一种接口文档的自动生成方法及终端设备 |
Cited By (27)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN112667274A (zh) * | 2019-10-15 | 2021-04-16 | 北京地平线机器人技术研发有限公司 | 生成应用程序编程接口文档的方法、装置及电子设备 |
| CN110825430A (zh) * | 2019-11-08 | 2020-02-21 | 政采云有限公司 | 一种api文档生成方法、装置、设备及存储介质 |
| CN110941950A (zh) * | 2019-11-26 | 2020-03-31 | 北京明略软件系统有限公司 | 接口文档的生成方法、装置、服务器及存储介质 |
| CN110941950B (zh) * | 2019-11-26 | 2023-03-17 | 北京明略软件系统有限公司 | 接口文档的生成方法、装置、服务器及存储介质 |
| CN111190594A (zh) * | 2019-12-23 | 2020-05-22 | 北京健康之家科技有限公司 | Vue组件的文档生成方法及装置 |
| CN111190594B (zh) * | 2019-12-23 | 2023-09-22 | 北京水滴科技集团有限公司 | Vue组件的文档生成方法及装置 |
| CN111240653A (zh) * | 2019-12-31 | 2020-06-05 | 瑞庭网络技术（上海）有限公司 | 接口文档生成方法、装置及可读存储介质 |
| CN111240653B (zh) * | 2019-12-31 | 2024-02-02 | 瑞庭网络技术（上海）有限公司 | 接口文档生成方法、装置及可读存储介质 |
| CN111400219A (zh) * | 2020-03-15 | 2020-07-10 | 杭州卓健信息科技有限公司 | 接口适配器及其电子设备 |
| CN111447279B (zh) * | 2020-03-27 | 2023-04-18 | 广州方硅信息技术有限公司 | 服务器及接口解析服务包生成方法 |
| CN111414161B (zh) * | 2020-03-27 | 2023-05-12 | 北京字节跳动网络技术有限公司 | 一种生成idl文件的方法、装置、介质和电子设备 |
| CN111414161A (zh) * | 2020-03-27 | 2020-07-14 | 北京字节跳动网络技术有限公司 | 一种生成idl文件的方法、装置、介质和电子设备 |
| CN111447279A (zh) * | 2020-03-27 | 2020-07-24 | 广州华多网络科技有限公司 | 服务器及接口解析服务包生成方法 |
| CN111507079B (zh) * | 2020-04-08 | 2023-08-18 | 杭州涂鸦信息技术有限公司 | 一种多语言文档生成方法及系统和设备 |
| CN111507079A (zh) * | 2020-04-08 | 2020-08-07 | 杭州涂鸦信息技术有限公司 | 一种多语言文档生成方法及系统和设备 |
| CN111767096B (zh) * | 2020-06-29 | 2024-08-16 | 深圳前海微众银行股份有限公司 | 接口文档的生成方法、装置、设备及计算机可读存储介质 |
| CN111767096A (zh) * | 2020-06-29 | 2020-10-13 | 深圳前海微众银行股份有限公司 | 接口文档的生成方法、装置、设备及计算机可读存储介质 |
| CN111880778A (zh) * | 2020-06-30 | 2020-11-03 | 百度在线网络技术（北京）有限公司 | 接口文档的生成方法、装置、电子设备及存储介质 |
| CN111880778B (zh) * | 2020-06-30 | 2023-12-22 | 百度在线网络技术（北京）有限公司 | 接口文档的生成方法、装置、电子设备及存储介质 |
| CN112131293A (zh) * | 2020-09-21 | 2020-12-25 | 平安国际智慧城市科技股份有限公司 | 接口管理方法、装置、终端设备及存储介质 |
| CN112306549A (zh) * | 2020-10-30 | 2021-02-02 | 康键信息技术（深圳）有限公司 | 接口文档配置方法、装置、设备及存储介质 |
| CN112433753A (zh) * | 2020-11-25 | 2021-03-02 | 平安普惠企业管理有限公司 | 基于参数信息的接口文档生成方法、装置、设备和介质 |
| CN112685078A (zh) * | 2020-12-30 | 2021-04-20 | 平安证券股份有限公司 | 接口文档生成与查询方法、装置及计算机可读存储介质 |
| CN113094093A (zh) * | 2021-03-29 | 2021-07-09 | 四川新网银行股份有限公司 | 一种基于互联网金融系统从源码生成系统交互的api文档的方法 |
| CN113419738A (zh) * | 2021-06-22 | 2021-09-21 | 未鲲(上海)科技服务有限公司 | 接口文档的生成方法、装置及接口管理设备 |
| CN116149882B (zh) * | 2023-04-19 | 2023-08-08 | 北京轻松筹信息技术有限公司 | 一种生成接口描述文件的方法、装置、设备和存储介质 |
| CN116149882A (zh) * | 2023-04-19 | 2023-05-23 | 北京轻松筹信息技术有限公司 | 一种生成接口描述文件的方法、装置、设备和存储介质 |
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| CN110308930A (zh) | 接口文档生成方法、装置、计算机设备和存储介质 | |
| US7877251B2 (en) | Document translation system | |
| CN103283209B (zh) | 一种应用服务平台系统及其实现方法 | |
| CN103389895B (zh) | 一种前端页面的生成方法及系统 | |
| US9483260B1 (en) | Documentation generation for web APIs based on byte code analysis | |
| US8375362B1 (en) | Wizard for web service search adapter | |
| CN110275831A (zh) | 协议接口的mock数据校验方法和装置 | |
| CN110806863A (zh) | 接口文档生成方法及装置、电子设备、存储介质 | |
| CN107015804B (zh) | 一种通过配置api快速开发项目的方法及系统 | |
| CN102426519B (zh) | 基于关联数据的bpel模板和服务的复用方法及其系统 | |
| US20110196891A1 (en) | Class loading using java data cartridges | |
| US20110161356A1 (en) | Extensible language framework using data cartridges | |
| EP2938044B1 (en) | System, method, apparatus, and server for displaying network medium information | |
| US20150100879A1 (en) | Framework for dependency management and automatic file load in a network environment | |
| CN107766344B (zh) | 一种模板渲染的方法、装置及浏览器 | |
| US20190050376A1 (en) | Automatic value formatting based on intrinsic structural semantics | |
| US20120110482A1 (en) | Method and apparatus for generating widget | |
| CN110727417B (zh) | 一种数据处理方法和装置 | |
| CN111045683A (zh) | 小程序代码编译方法、装置、设备及介质 | |
| CN114036425A (zh) | 页面访问方法、客户端、服务端及系统 | |
| CN111460241A (zh) | 一种数据查询方法、装置、电子设备及存储介质 | |
| US7949610B2 (en) | Method and system for discovering dependencies in project plans of distributed system | |
| US9996344B2 (en) | Customized runtime environment | |
| CN113268232B (zh) | 一种页面皮肤生成方法、装置和计算机可读存储介质 | |
| JP2019101889A (ja) | テスト実行装置及びプログラム |
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 | ||
| EE01 | Entry into force of recordation of patent licensing contract |
Application publication date: 20191008 Assignee: GUANGZHOU CUBESILI INFORMATION TECHNOLOGY Co.,Ltd. Assignor: GUANGZHOU HUADUO NETWORK TECHNOLOGY Co.,Ltd. Contract record no.: X2021440000031 Denomination of invention: Interface document generation method, device, computer device and storage medium License type: Common License Record date: 20210125 |
|
| EE01 | Entry into force of recordation of patent licensing contract | ||
| RJ01 | Rejection of invention patent application after publication |
Application publication date: 20191008 |
|
| RJ01 | Rejection of invention patent application after publication |