CN116185393A - 接口文档的生成方法、装置、设备、介质及产品 - Google Patents

Abstract

本发明公开了一种接口文档的生成方法、装置、设备、介质及产品。本发明涉及计算机技术领域。该方法包括：获取目标项目的接口参数；其中，所述接口参数至少包括项目令牌、项目标识及接口地址信息；确定所述目标项目采用的协议类型，基于所述协议类型对所述目标项目的代码文件进行解析，获得接口信息；其中，所述接口信息至少包括接口列表、请求参数及响应参数；对所述接口信息进行规范化处理，获得接口文档；基于所述接口参数将规范化处理后的接口文档进行上传。利用该方法，可以高效的生成业务项目的接口文档，利于接口文档的维护及更新。

Description

接口文档的生成方法、装置、设备、介质及产品

技术领域

本发明实施例涉及计算机技术领域，尤其涉及一种接口文档的生成方法、装置、设备、存储介质及程序产品。

背景技术

目前大部分互联网(web)项目都是前后端分离的。一项功能的完成需要前端、后端及测试的参与。前后端同时评审、完善接口文档，确定测试用例。

目前，接收文档的生成包括如下几种方式：一种方式是手写接口文档，效率低下；另一种是采用现有接口服务(如：swagger)生成接口文档，这种方式需要编写注解，使得代码复杂，且具有入侵代码的风险。

发明内容

本发明实施例提供一种接口文档的生成方法、装置、设备及存储介质，可以高效的生成业务项目的接口文档，利于接口文档的维护及更新。

第一方面，本发明实施例提供了一种接口文档的生成方法，包括：

获取目标项目的接口参数；其中，所述接口参数至少包括项目令牌、项目标识及接口地址信息；

确定所述目标项目采用的协议类型，基于所述协议类型对所述目标项目的代码文件进行解析，获得接口信息；其中，所述接口信息至少包括接口列表、请求参数及响应参数；

对所述接口信息进行规范化处理，获得接口文档；

基于所述接口参数将规范化处理后的接口文档进行上传。

第二方面，本发明实施例还提供了一种接口文档的生成装置，包括：

接口参数获取模块，用于获取目标项目的接口参数；其中，所述接口参数至少包括项目令牌、项目标识及接口地址信息；

代码文件解析模块，用于确定所述目标项目采用的协议类型，基于所述协议类型对所述目标项目的代码文件进行解析，获得接口信息；其中，所述接口信息至少包括接口列表、请求参数及响应参数；

规范化处理模块，用于对所述接口信息进行规范化处理，获得接口文档；

接口文档上传模块，用于基于所述接口参数将规范化处理后的接口文档进行上传。

第三方面，本发明实施例还提供了一种电子设备，包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，所述处理器执行所述程序时实现如本发明实施例中任一所述的接口文档的生成方法。

第四方面，本发明实施例还提供了一种计算机可读存储介质，其上存储有计算机程序，该程序被处理器执行时实现如本发明实施例中任一所述的接口文档的生成方法。

第五方面，本发明实施例还提供了一种计算机程序产品，包括计算机程序，所述计算机程序在被处理器执行时实现如本发明实施例中任一所述的接口文档的生成方法。

本发明实施例中，通过获取目标项目的接口参数；其中，所述接口参数至少包括项目令牌、项目标识及接口地址信息；确定所述目标项目采用的协议类型，基于所述协议类型对所述目标项目的代码文件进行解析，获得接口信息；其中，所述接口信息至少包括接口列表、请求参数及响应参数；对所述接口信息进行规范化处理，获得接口文档；基于所述接口参数将规范化处理后的接口文档进行上传。利用该方法，可以高效的生成业务项目的接口文档，利于接口文档的维护及更新。

附图说明

为了更清楚地说明本发明实施例的技术方案，下面将对实施例中所需要使用的附图作简单地介绍，应当理解，以下附图仅示出了本发明的某些实施例，因此不应被看作是对范围的限定，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他相关的附图。

图1为本发明实施例提供的一种接口文档的生成方法的流程图；

图2为本发明实施例提供的一种接口文档的生成装置的结构示意图；

图3为本发明实施例提供的一种电子设备的结构示意图。

具体实施方式

下面结合附图和实施例对本发明作进一步的详细说明。可以理解的是，此处所描述的具体实施例仅仅用于解释本发明，而非对本发明的限定。另外还需要说明的是，为了便于描述，附图中仅示出了与本发明相关的部分而非全部结构。

应注意到：相似的标号和字母在下面的附图中表示类似项，因此，一旦某一项在一个附图中被定义，则在随后的附图中不需要对其进行进一步定义和解释。同时，在本发明的描述中，术语“第一”、“第二”等仅用于区分描述，而不能理解为指示或暗示相对重要性。本申请技术方案中对数据的获取、存储、使用、处理等均符合国家法律法规的相关规定。

图1为本发明实施例提供的一种接口文档的生成方法的流程图，本实施例可适用于接口文档的生成的情况，该方法可以由接口文档的生成装置来执行，该接口文档的生成装置可以采用硬件和/或软件的形式实现，该接口文档的生成装置可配置于电子设备中，该电子设备可以是移动终端、PC端或服务器等。如图1所示，该方法包括：

S110、获取目标项目的接口参数。

其中，接口参数至少包括项目令牌、项目标识及接口地址信息。

具体的，接口参数可以是项目在接口管理平台的相关配置信息用于接口文档的生成的参数信息。其中，接口参数至少包括项目令牌、项目标识及接口地址信息。项目标识可以是能够识别出该项目的标识信息。接口地址信息可以是接口文档与接口对应的路径信息或地址信息。

首先在预先部署的接口管理平台中创建目标项目，然后对目标项目进行参数配置，获取该目标项目的接口参数信息。其中，接口参数至少包括项目令牌、项目标识及接口地址信息。

可选的，获取目标项目的接口参数的方式可以是：在预先部署的接口管理平台中创建目标项目；对目标项目进行参数配置，得到接口参数。

具体的，首先预先部署一个接口管理平台，在预先部署的接口管理平台中创建目标项目，在创建目标项目的时对目标项目进行参数配置，获得相应的接口参数。其中，接口参数至少包括项目令牌、项目标识及接口地址信息。

在本实施例中，通过部署接口管理平台，可以方便进行项目接口管理。使接口开发更加简单高效，让接口管理具有可读性及可维护性。

可选的，在获取目标项目的接口参数之后，还包括：对项目令牌和/或项目标识的编写规则进行校验；对接口地址的连通性进行校验。

具体的，在获取目标项目的接口参数之后，对项目令牌和/或项目标识的编写规则进行校验包括下述至少一个：项目令牌和/或项目标识的定义类型是否正确、字段的顺序及字段的长度是否正确及编写方式是否符合业务的需求。对于获取的接口地址，校验该地址是否可以访问，保证该接口地址的连通性。

在本实施例中，通过对接口参数进行合理性校验，保证网络连通性。

S120、确定目标项目采用的协议类型，基于协议类型对目标项目的代码文件进行解析，获得接口信息。

其中，接口信息至少包括接口列表、请求参数及响应参数。

在本实施例中，协议类型中可以包括超文本传输协议(HTTP，HyperText TransferProtocol)、dubbo协议、feign协议等协议类型或者是自定义注解的类型。

具体的，对于目标项目所采用的协议类型进行确定，根据协议类型的选择不同代码解析流程，对目标项目的代码文件进行解析，最终获得接口信息，其中，接口信息至少包括接口列表、请求参数及响应参数。

可选的，基于协议类型对目标项目的代码文件进行解析，获得接口信息的方式可以是：获取协议类型对应的解析规则；基于解析规则对目标项目的代码文件进行解析，获得接口信息。

具体的，根据确定的目标项目采用的协议类型，则获取该协议类型对应的解析规则，基于解析规则提取代码文件中的注释内容，对注释内容进行解析，获得接口信息。

示例性的，如果该目标项目采用的协议类型为dubbo协议，则就选择dubbo协议类型对应的解析规则，如果是自定义注解就根据相应类型定义，获取该类型对应的解析规则。

在本实施例中，通过根据不同协议类型选择不同代码解析流程，使得接口文档的生成不受协议类型不同的影响。

可选的，基于解析规则对目标项目的代码文件进行解析，获得接口信息的方式可以是：基于解析规则提取代码文件中的注释内容；对注释内容进行解析，获得接口信息。

具体的，注释内容可以是字段备注中的注释，用于解释代码文件中代码的含义或者解释。

具体的，基于该目标项目对应的解析规则对目标项目的代码文件进行解析，提取代码文件中的注释内容，对注释内容进行解析，通过接口上的注释，或者引用上的注释，生成接口名称，获得接口信息。

可选的，基于解析规则对目标项目的代码文件进行解析，获得接口信息的方式可以是：接收用户在代码文件中选择的代码单元和/或代码元素；其中，代码单元包括代码元素，代码单元包括类单元和接口单元，代码元素包括方法元素；基于解析规则提取代码单元和/或代码元素中的注释内容；对注释内容进行解析，获得代码单元和/或代码元素的接口信息。

具体的，代码单元可以是指一个代码文件中具有最短的比特组合的单元。

具体的，接收用户在代码文件中选择的代码单元和/或代码元素；其中，代码单元包括代码元素，代码单元包括类单元和接口单元，代码元素包括方法元素。基于该目标项目对应的解析规则对目标项目的代码文件进行解析，提取代码文件中代码单元和/或代码元素中的注释内容，对注释内容进行解析，通过接口上的注释，或者引用上的注释，生成接口名称，获得代码单元和/或代码元素的接口信息。

S130、对接口信息进行规范化处理，获得接口文档。

具体的，接口文档可以是一种有规范的格式和内容要求的文档，需要由前后端工程师共同定义接口，编写接口文档，后端按照接口协议接收前端传递的合法数据和返回符合的规范的数据，前端按照接口协议传递符合规范的数据和对后端返回的数据依据展示的需要做处理。

具体的，获取目标项目对应的接口规范，基于接口规范对接口信息进行规范化处理，获得接口文档。

可选的，对接口信息进行规范化处理，获得接口文档的方式可以是：获取目标项目对应的接口规范；基于接口规范对接口信息进行规范化处理，获得接口文档。

具体的，获取目标项目对应的接口规范，根据上传接口规范要求转换生成接口规范参数，格式化相应参数信息，获得接口文档。

在本实施例中，通过对接口信息进行规范化处理，能够让前端开发与后台开发人员更好的配合，提高工作效率，项目迭代或者项目人员更迭时，方便后期人员查看和维护，方便测试人员进行接口测试。

S140、基于接口参数将规范化处理后的接口文档进行上传。

具体的，基于接口参数中项目令牌、项目标识及接口地址信息，确定目标项目所在的目录或者子目录，将规范化处理后的接口文档进行上传，上传至对应的目录或者子目录下。

可选的，基于接口参数将规范化处理后的接口文档进行上传的方式可以是：基于接口参数确定目标项目所在的目录；将规范化处理后的接口文档上传至目录下。

具体的，基于接口参数中项目令牌、项目标识及接口地址信息，确定目标项目所在的目录，将规范化处理后的接口文档进行上传，上传至对应的目录下。

可选的，基于接口参数将规范化处理后的接口文档进行上传的方式可以是：基于接口参数确定目标项目所在的目录；在目录中确定代码单元和/或代码元素所在的子目录；将规范化处理后的接口文档上传至子目录下。

具体的，基于接口参数中项目令牌、项目标识及接口地址信息，确定目标项目所在的目录，根据代码单元和/或代码元素在目录中确定代码单元和/或代码元素所在的子目录，将规范化处理后的接口文档进行上传，上传至对应的子目录下。

可选的，基于接口参数将规范化处理后的接口文档进行上传之后，还包括：基于用户的查询操作将接口文档展示在界面中。

具体的，将规范化处理后的接口文档进行上传之后，用户可以在接口管理平台进行查询操作，根据查询操作查询的接口文档展示在平台界面中。

本发明实施例中，通过获取目标项目的接口参数；其中，接口参数至少包括项目令牌、项目标识及接口地址信息；确定目标项目采用的协议类型，基于协议类型对目标项目的代码文件进行解析，获得接口信息；其中，接口信息至少包括接口列表、请求参数及响应参数；对接口信息进行规范化处理，获得接口文档；基于接口参数将规范化处理后的接口文档进行上传。利用该方法，可以高效的生成业务项目的接口文档，利于接口文档的维护及更新。

图2为本发明实施例提供的一种接口文档的生成装置的结构示意图。如图2所示，接口参数获取模块210、代码文件解析模块220、规范化处理模块230、接口文档上传模块240；

接口参数获取模块210，用于获取目标项目的接口参数；其中，所述接口参数至少包括项目令牌、项目标识及接口地址信息；

代码文件解析模块220，用于确定所述目标项目采用的协议类型，基于所述协议类型对所述目标项目的代码文件进行解析，获得接口信息；其中，所述接口信息至少包括接口列表、请求参数及响应参数；

规范化处理模块230，用于对所述接口信息进行规范化处理，获得接口文档；

接口文档上传模块240，用于基于所述接口参数将规范化处理后的接口文档进行上传。

本发明实施例中，通过获取目标项目的接口参数；其中，所述接口参数至少包括项目令牌、项目标识及接口地址信息；确定所述目标项目采用的协议类型，基于所述协议类型对所述目标项目的代码文件进行解析，获得接口信息；其中，所述接口信息至少包括接口列表、请求参数及响应参数；对所述接口信息进行规范化处理，获得接口文档；基于所述接口参数将规范化处理后的接口文档进行上传。利用该方法，可以高效的生成业务项目的接口文档，利于接口文档的维护及更新。

可选的，接口参数获取模块210可以具体用于：

在预先部署的接口管理平台中创建目标项目；

对所述目标项目进行参数配置，得到接口参数。

可选的，在获取目标项目的接口参数之后，装置还可以具体用于：

对所述项目令牌和/或所述项目标识的编写规则进行校验；

对所述接口地址的连通性进行校验。

可选的，代码文件解析模块220可以具体用于：

获取所述协议类型对应的解析规则；

基于所述解析规则对所述目标项目的代码文件进行解析，获得接口信息。

可选的，代码文件解析模块220可以具体用于：

基于所述解析规则提取所述代码文件中的注释内容；

对所述注释内容进行解析，获得接口信息。

可选的，接口文档上传模块240可以具体用于：

基于所述接口参数确定所述目标项目所在的目录；

将规范化处理后的接口文档上传至所述目录下。

可选的，代码文件解析模块220可以具体用于：

接收用户在所述代码文件中选择的代码单元和/或代码元素；其中，所述代码单元包括代码元素，所述代码单元包括类单元和接口单元，所述代码元素包括方法元素；

基于所述解析规则提取所述代码单元和/或代码元素中的注释内容；

对所述注释内容进行解析，获得所述代码单元和/或代码元素的接口信息。

可选的，接口文档上传模块240还可以具体用于：

基于所述接口参数确定所述目标项目所在的目录；

在所述目录中确定所述代码单元和/或代码元素所在的子目录；

将规范化处理后的接口文档上传至所述子目录下。

可选的，接口文档上传模块240可以具体用于：

获取所述目标项目对应的接口规范；

基于所述接口规范对所述接口信息进行规范化处理，获得接口文档。

可选的，装置还可以包括：展示模块。

展示模块可以具体用于：

基于用户的查询操作将所述接口文档展示在界面中。

本发明实施例所提供的接口文档的生成装置可执行本发明任意实施例所提供的接口文档的生成方法，具备执行方法相应的功能模块和有益效果。

图3为本发明实施例提供的一种电子设备的结构示意图。图3示出了适于用来实现本发明实施方式的电子设备12的框图。图3显示的电子设备12仅仅是一个示例，不应对本发明实施例的功能和使用范围带来任何限制。设备12是典型的实现接口文档的生成的电子设备。

如图3所示，电子设备12以通用计算设备的形式表现。电子设备12的组件可以包括但不限于：一个或者多个处理器16，存储器28，连接不同系统组件(包括存储器28和处理器16)的总线18。

总线18表示几类总线结构中的一种或多种，包括存储器总线或者存储器控制器，外围总线，图形加速端口，处理器或者使用多种总线结构中的任意总线结构的局域总线。举例来说，这些体系结构包括但不限于工业标准体系结构(Industry StandardArchitecture，ISA)总线，微通道体系结构(Micro Channel Architecture，MCA)总线，增强型ISA总线、视频电子标准协会(Video Electronics Standards Association，VESA)局域总线以及外围组件互连(Peripheral Component Interconnect，PCI)总线。

电子设备12典型地包括多种计算机系统可读介质。这些介质可以是任何能够被电子设备12访问的可用介质，包括易失性和非易失性介质，可移动的和不可移动的介质。

存储器28可以包括易失性存储器形式的计算机系统可读介质，例如随机存取存储器(Random Access Memory，RAM)30和/或高速缓存存储器32。电子设备12可以进一步包括其它可移动/不可移动的、易失性/非易失性计算机系统存储介质。仅作为举例，存储系统34可以用于读写不可移动的、非易失性磁介质(图3未显示，通常称为“硬盘驱动器”)。尽管图3中未示出，可以提供用于对可移动非易失性磁盘(例如“软盘”)读写的磁盘驱动器，以及对可移动非易失性光盘(例如只读光盘(Compact Disc-Read Only Memory，CD-ROM)、数字视盘(Digital Video Disc-Read Only Memory，DVD-ROM)或者其它光介质)读写的光盘驱动器。在这些情况下，每个驱动器可以通过一个或者多个数据介质接口与总线18相连。存储器28可以包括至少一个程序产品，该程序产品具有一组(例如至少一个)程序模块，这些程序模块被配置以执行本发明各实施例的功能。

具有一组(至少一个)程序模块26的程序36，可以存储在例如存储28中，这样的程序模块26包括但不限于操作系统、一个或者多个应用程序、其它程序模块以及程序数据，这些示例中的每一个或某种组合中可能包括网络环境的实现。程序模块26通常执行本发明所描述的实施例中的功能和/或方法。

电子设备12也可以与一个或多个外部设备14(例如键盘、指向设备、摄像头、显示器24等)通信，还可与一个或者多个使得用户能与该电子设备12交互的设备通信，和/或与使得该电子设备12能与一个或多个其它计算设备进行通信的任何设备(例如网卡，调制解调器等等)通信。这种通信可以通过输入/输出(I/O)接口22进行。并且，电子设备12还可以通过网络适配器20与一个或者多个网络(例如局域网(Local Area Network，LAN)，广域网Wide Area Network，WAN)和/或公共网络，例如因特网)通信。如图所示，网络适配器20通过总线18与电子设备12的其它模块通信。应当明白，尽管图中未示出，可以结合电子设备12使用其它硬件和/或软件模块，包括但不限于：微代码、设备驱动器、冗余处理单元、外部磁盘驱动阵列、磁盘阵列(Redundant Arrays of Independent Disks，RAID)系统、磁带驱动器以及数据备份存储系统等。

处理器16通过运行存储在存储器28中的程序，从而执行各种功能应用以及数据处理，例如实现本发明上述实施例所提供的接口文档的生成方法。

本发明实施例提供了一种计算机可读存储介质，该计算机可读存储介质上存储有计算机程序，该程序被处理装置执行时实现如本发明实施例中的接口文档的生成方法。本发明上述的计算机可读介质可以是计算机可读信号介质或者计算机可读存储介质或者是上述两者的任意组合。计算机可读存储介质例如可以是——但不限于——电、磁、光、电磁、红外线、或半导体的系统、装置或器件，或者任意以上的组合。计算机可读存储介质的更具体的例子可以包括但不限于：具有一个或多个导线的电连接、便携式计算机磁盘、硬盘、随机访问存储器(RAM)、只读存储器(ROM)、可擦式可编程只读存储器(EPROM或闪存)、光纤、便携式紧凑磁盘只读存储器(CD-ROM)、光存储器件、磁存储器件、或者上述的任意合适的组合。在本公开中，计算机可读存储介质可以是任何包含或存储程序的有形介质，该程序可以被指令执行系统、装置或者器件使用或者与其结合使用。而在本公开中，计算机可读信号介质可以包括在基带中或者作为载波一部分传播的数据信号，其中承载了计算机可读的程序代码。这种传播的数据信号可以采用多种形式，包括但不限于电磁信号、光信号或上述的任意合适的组合。计算机可读信号介质还可以是计算机可读存储介质以外的任何计算机可读介质，该计算机可读信号介质可以发送、传播或者传输用于由指令执行系统、装置或者器件使用或者与其结合使用的程序。计算机可读介质上包含的程序代码可以用任何适当的介质传输，包括但不限于：电线、光缆、RF(射频)等等，或者上述的任意合适的组合。

在一些实施方式中，客户端、服务器可以利用诸如HTTP(HyperText TransferProtocol，超文本传输协议)之类的任何当前已知或未来研发的网络协议进行通信，并且可以与任意形式或介质的数字数据通信(例如，通信网络)互连。通信网络的示例包括局域网(“LAN”)，广域网(“WAN”)，网际网(例如，互联网)以及端对端网络(例如，ad hoc端对端网络)，以及任何当前已知或未来研发的网络。

上述计算机可读介质可以是上述电子设备中所包含的；也可以是单独存在，而未装配入该电子设备中。

上述计算机可读介质承载有一个或者多个程序，当上述一个或者多个程序被该电子设备执行时，使得该电子设备：当目标用户触发智能客服服务时，获取所述目标用户的用户标识；根据所述用户标识确定至少一个交互任务；其中所述交互任务包括多个任务要素；根据所述任务要素从所述至少一个交互任务中确定目标交互任务；执行所述目标交互任务以与所述目标用户进行交互。

可以以一种或多种程序设计语言或其组合来编写用于执行本公开的操作的计算机程序代码，上述程序设计语言包括但不限于面向对象的程序设计语言—诸如Java、Smalltalk、C++，还包括常规的过程式程序设计语言—诸如“C”语言或类似的程序设计语言。程序代码可以完全地在用户计算机上执行、部分地在用户计算机上执行、作为一个独立的软件包执行、部分在用户计算机上部分在远程计算机上执行、或者完全在远程计算机或服务器上执行。在涉及远程计算机的情形中，远程计算机可以通过任意种类的网络——包括局域网(LAN)或广域网(WAN)—连接到用户计算机，或者，可以连接到外部计算机(例如利用因特网服务提供商来通过因特网连接)。

附图中的流程图和框图，图示了按照本公开各种实施例的系统、方法和计算机程序产品的可能实现的体系架构、功能和操作。在这点上，流程图或框图中的每个方框可以代表一个模块、程序段、或代码的一部分，该模块、程序段、或代码的一部分包含一个或多个用于实现规定的逻辑功能的可执行指令。也应当注意，在有些作为替换的实现中，方框中所标注的功能也可以以不同于附图中所标注的顺序发生。例如，两个接连地表示的方框实际上可以基本并行地执行，它们有时也可以按相反的顺序执行，这依所涉及的功能而定。也要注意的是，框图和/或流程图中的每个方框、以及框图和/或流程图中的方框的组合，可以用执行规定的功能或操作的专用的基于硬件的系统来实现，或者可以用专用硬件与计算机指令的组合来实现。

描述于本公开实施例中所涉及到的单元可以通过软件的方式实现，也可以通过硬件的方式来实现。其中，单元的名称在某种情况下并不构成对该单元本身的限定。

本文中以上描述的功能可以至少部分地由一个或多个硬件逻辑部件来执行。例如，非限制性地，可以使用的示范类型的硬件逻辑部件包括：现场可编程门阵列(FPGA)、专用集成电路(ASIC)、专用标准产品(ASSP)、片上系统(SOC)、复杂可编程逻辑设备(CPLD)等等。

在本公开的上下文中，机器可读介质可以是有形的介质，其可以包含或存储以供指令执行系统、装置或设备使用或与指令执行系统、装置或设备结合地使用的程序。机器可读介质可以是机器可读信号介质或机器可读储存介质。机器可读介质可以包括但不限于电子的、磁性的、光学的、电磁的、红外的、或半导体系统、装置或设备，或者上述内容的任何合适组合。机器可读存储介质的更具体示例会包括基于一个或多个线的电气连接、便携式计算机盘、硬盘、随机存取存储器(RAM)、只读存储器(ROM)、可擦除可编程只读存储器(EPROM或快闪存储器)、光纤、便捷式紧凑盘只读存储器(CD-ROM)、光学储存设备、磁储存设备、或上述内容的任何合适组合。

本发明实施例还提供了一种计算机程序产品，包括计算机程序，该计算机程序在被处理器执行时实现如本申请任一实施例所提供的接口文档的生成方法。

计算机程序产品在实现的过程中，可以以一种或多种程序设计语言或其组合来编写用于执行本发明操作的计算机程序代码，程序设计语言包括面向对象的程序设计语言，诸如Java、Smalltalk、C++，还包括常规的过程式程序设计语言，诸如“C”语言或类似的程序设计语言。程序代码可以完全地在用户计算机上执行、部分地在用户计算机上执行、作为一个独立的软件包执行、部分在用户计算机上部分在远程计算机上执行、或者完全在远程计算机或服务器上执行。在涉及远程计算机的情形中，远程计算机可以通过任意种类的网络——包括局域网(LAN)或广域网(WAN)—连接到用户计算机，或者，可以连接到外部计算机(例如利用因特网服务提供商来通过因特网连接)。

注意，上述仅为本发明的较佳实施例及所运用技术原理。本领域技术人员会理解，本发明不限于这里的特定实施例，对本领域技术人员来说能够进行各种明显的变化、重新调整和替代而不会脱离本发明的保护范围。因此，虽然通过以上实施例对本发明进行了较为详细的说明，但是本发明不仅仅限于以上实施例，在不脱离本发明构思的情况下，还可以包括更多其他等效实施例，而本发明的范围由所附的权利要求范围决定。

Claims (15)

1.一种接口文档的生成方法，其特征在于，包括：

获取目标项目的接口参数；其中，所述接口参数至少包括项目令牌、项目标识及接口地址信息；

确定所述目标项目采用的协议类型，基于所述协议类型对所述目标项目的代码文件进行解析，获得接口信息；其中，所述接口信息至少包括接口列表、请求参数及响应参数；

对所述接口信息进行规范化处理，获得接口文档；

基于所述接口参数将规范化处理后的接口文档进行上传。

2.根据权利要求1所述的方法，其特征在于，获取目标项目的接口参数，包括：

在预先部署的接口管理平台中创建目标项目；

对所述目标项目进行参数配置，得到接口参数。

3.根据权利要求2所述的方法，其特征在于，在获取目标项目的接口参数之后，还包括：

对所述项目令牌和/或所述项目标识的编写规则进行校验；

对所述接口地址的连通性进行校验。

4.根据权利要求1所述的方法，其特征在于，基于所述协议类型对所述目标项目的代码文件进行解析，获得接口信息，包括：

获取所述协议类型对应的解析规则；

基于所述解析规则对所述目标项目的代码文件进行解析，获得接口信息。

5.根据权利要求4所述的方法，其特征在于，基于所述解析规则对所述目标项目的代码文件进行解析，获得接口信息，包括：

基于所述解析规则提取所述代码文件中的注释内容；

对所述注释内容进行解析，获得接口信息。

6.根据权利要求5所述的方法，其特征在于，基于所述接口参数将规范化处理后的接口文档进行上传，包括：

基于所述接口参数确定所述目标项目所在的目录；

将规范化处理后的接口文档上传至所述目录下。

7.根据权利要求4所述的方法，其特征在于，基于所述解析规则对所述目标项目的代码文件进行解析，获得接口信息，包括：

接收用户在所述代码文件中选择的代码单元和/或代码元素；其中，所述代码单元包括代码元素，所述代码单元包括类单元和接口单元，所述代码元素包括方法元素；

基于所述解析规则提取所述代码单元和/或代码元素中的注释内容；

对所述注释内容进行解析，获得所述代码单元和/或代码元素的接口信息。

8.根据权利要求7所述的方法，其特征在于，基于所述接口参数将规范化处理后的接口文档进行上传，包括：

基于所述接口参数确定所述目标项目所在的目录；

在所述目录中确定所述代码单元和/或代码元素所在的子目录；

将规范化处理后的接口文档上传至所述子目录下。

9.根据权利要求1所述的方法，其特征在于，对所述接口信息进行规范化处理，获得接口文档，包括：

获取所述目标项目对应的接口规范；

基于所述接口规范对所述接口信息进行规范化处理，获得接口文档。

10.根据权利要求1所述的方法，其特征在于，基于所述接口参数将规范化处理后的接口文档进行上传之后，还包括：

基于用户的查询操作将所述接口文档展示在界面中。

11.一种接口文档的生成装置，其特征在于，包括：

接口参数获取模块，用于获取目标项目的接口参数；其中，所述接口参数至少包括项目令牌、项目标识及接口地址信息；

代码文件解析模块，用于确定所述目标项目采用的协议类型，基于所述协议类型对所述目标项目的代码文件进行解析，获得接口信息；其中，所述接口信息至少包括接口列表、请求参数及响应参数；

规范化处理模块，用于对所述接口信息进行规范化处理，获得接口文档；

接口文档上传模块，用于基于所述接口参数将规范化处理后的接口文档进行上传。

12.一种接口文档的生成装置，其特征在于，包括：

代码单元选取模块，用于接收用户在所述代码文件中选择的代码单元和/或代码元素；其中，所述代码单元包括代码元素，所述代码单元包括类单元和接口单元，所述代码元素包括方法元素；

注释内容提取模块，用于基于所述解析规则提取所述代码单元和/或代码元素中的注释内容；

接口信息解析模块，用于对所述注释内容进行解析，获得所述代码单元和/或代码元素的接口信息。

13.一种电子设备，其特征在于，包括存储器，处理器及存储在存储器上并可在处理器运行的计算机程序，其特征在于，所述处理器执行所述计算机程序时实现如权利要求1-10中任一项所述的接口文档的生成方法。

14.一种计算机可读存储介质，其上存储有计算机程序，其特征在于，该程序被处理器执行时实现如权利要求1-10中任一所述的接口文档的生成方法。

15.一种计算机程序产品，包括计算机程序，其特征在于，所述计算机程序在被处理器执行时实现如权利要求1-10中任一项所述的接口文档的生成方法。

Images