CN115146604B - 一种接口技术文档的生成方法、装置、设备及存储介质 - Google Patents

Abstract

本发明实施例公开了一种接口技术文档的生成方法、装置、设备及存储介质，该方法包括：接收针对接口技术文档的生成请求，所述生成请求包括目标接口标识，根据所述目标接口标识，获取与目标接口相关联的目标参数信息、所述目标接口的接口信息以及接口地址，根据所述目标参数信息确定所述目标接口的方法清单，基于所述方法清单、所述接口地址以及所述接口信息，生成所述目标接口的接口技术文档，实现自动生成接口技术文档，减少了用户手动编写接口技术文档的时间，提高了接口技术文档生成的效率，同时也提高了接口技术文档的可读性和正确率。

Description

一种接口技术文档的生成方法、装置、设备及存储介质

技术领域

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

背景技术

在互联网发达的数字时代，各种系统之间的交互越来越频繁，多系统之间的交互需要通过各种各样的系统接口来实现，不同系统的开发人员，不熟悉对方系统接口的调用方法，这就需要为每一个系统接口编写一份技术说明书。技术文档是跨系统集成的重要输出文档，有着重要的意义。

目前，在SAP软件平台编写接口技术文档时，都是采用手工编写的方式。在SAP软件平台对于一些接口输入输出的数据，如果有几十个或达上百个字段,对技术说明书的编写是非常繁重的，尤其是接口中输入输出的数据对象发生变化时，这个技术文档的调整工作也将变得非常耗时。

另外，针对同一个接口而言，可能是通过不同的开发人员进行开发的，则手动编写技术文档时也很有可能由不同的开发人员针对自己开发的部分进行编写最后再汇总，这种情况下，在汇总成为接口技术文档后，每次某个开发人员根据自己负责的部分对技术文档进行调整得出的接口技术文档，很可能会忽略了其他开发人员也进行了调整的部分，技术文档难以实现实时同步。

发明内容

本发明提供了一种接口技术文档的生成方法、装置、设备及存储介质，以解决当前针对SAP软件平台的接口进行接口技术文档的编写时需要人工进行编写，耗费大量人力，以及在对接口技术文档发生改动时难以实现实时同步的问题。

根据本发明的一方面，提供了一种接口技术文档的生成方法，所述方法包括：

接收针对接口技术文档的生成请求，所述生成请求包括目标接口标识；

根据所述目标接口标识，获取与目标接口相关联的目标参数信息、所述目标接口的接口信息以及接口地址；

根据所述目标参数信息确定所述目标接口的方法清单；

基于所述方法清单、所述接口地址以及所述接口信息，生成所述目标接口的接口技术文档。

根据本发明的一方面，提供了一种接口技术文档的生成装置，所述装置包括：

生成请求接收模块，用于接收针对接口技术文档的生成请求，所述生成请求包括目标接口标识；

获取模块，用于根据所述目标接口标识，获取与目标接口相关联的目标参数信息、所述目标接口的接口信息以及接口地址；

方法清单确定模块，用于根据所述目标参数信息确定所述目标接口的方法清单；

接口技术文档生成模块，用于基于所述方法清单、所述接口地址以及所述接口信息，生成所述目标接口的接口技术文档。

根据本发明的另一方面，提供了一种电子设备，所述电子设备包括：

至少一个处理器；以及

与所述至少一个处理器通信连接的存储器；其中，

所述存储器存储有可被所述至少一个处理器执行的计算机程序，所述计算机程序被所述至少一个处理器执行，以使所述至少一个处理器能够执行本发明任一实施例所述的一种接口技术文档的生成方法。

根据本发明的另一方面，提供了一种计算机可读存储介质，所述计算机可读存储介质存储有计算机指令，所述计算机指令用于使处理器执行时实现本发明任一实施例所述的一种接口技术文档的生成方法。

本发明实施例的技术方案提供了一种接口技术文档的生成方法，该方法包括：接收针对接口技术文档的生成请求，生成请求包括目标接口标识，根据目标接口标识，获取与目标接口相关联的目标参数信息、目标接口的接口信息以及接口地址，根据目标参数信息确定目标接口的方法清单，基于方法清单、接口地址以及接口信息，生成目标接口的接口技术文档，减少了用户手动编写接口技术文档的时间，提高了接口技术文档生成的效率，同时也提高了接口技术文档的可读性和正确率。

应当理解，本部分所描述的内容并非旨在标识本发明的实施例的关键或重要特征，也不用于限制本发明的范围。本发明的其它特征将通过以下的说明书而变得容易理解。

附图说明

为了更清楚地说明本发明实施例中的技术方案，下面将对实施例描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。

图1是根据本发明实施例一提供的一种接口技术文档的生成方法的流程示意图；

图2是根据本发明实施例一提供的一种接口信息录入界面示意图；

图3是根据本发明实施例一提供的一种数据库配置示意图；

图4是根据本发明实施例一提供的一种目标参数信息库配置示意图；

图5是根据本发明实施例二提供的一种接口技术文档的生成装置的结构示意图；

图6是实现本发明实施例的一种接口技术文档的生成方法的电子设备的结构示意图。

具体实施方式

为了使本技术领域的人员更好地理解本发明方案，下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分的实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都应当属于本发明保护的范围。

需要说明的是，本发明的说明书和权利要求书及上述附图中的术语“第一”、“第二”等是用于区别类似的对象，而不必用于描述特定的顺序或先后次序。应该理解这样使用的数据在适当情况下可以互换，以便这里描述的本发明的实施例能够以除了在这里图示或描述的那些以外的顺序实施。此外，术语“包括”和“具有”以及他们的任何变形，意图在于覆盖不排他的包含，例如，包含了一系列步骤或单元的过程、方法、系统、产品或设备不必限于清楚地列出的那些步骤或单元，而是可包括没有清楚地列出的或对于这些过程、方法、产品或设备固有的其它步骤或单元。

实施例一

图1为本发明实施例一提供了一种接口技术文档的生成方法的流程示意图。

SAP软件平台(systems applications and products in data processing)是一款用于企业资源计划ERP(enterprise resource planning)管理的软件。

用户可以通过SAP软件平台内部的开发平台进行系统开发。本实施例所提供的一种接口技术文档的生成方法就是在SAP软件平台的基础上进行二次开发而实现。在SAP软件平台编写接口代码时，SAP软件平台本身具备对程序说明、接口说明、参数说明等内容进行记录并存储的功能，在SAP软件平台这些功能的支持下，通过二次开发，从SAP软件平台中获取相应的信息，并针对获得的信息整理后生成接口技术文档，可以实现接口技术文档的自动编写接口技术文档，并在发生内容更新时，得到的接口技术文档会同步更新，得到完整的、最新的接口技术文档。

如图1所示，该方法包括如下步骤：

S110、接收针对接口技术文档的生成请求，生成请求包括目标接口标识。

当接收到针对接口技术文档的生成请求时，可以根据生成请求中的目标接口标识来确认当前具有生成接口技术文档需求的接口。具体的，目标接口标识可以是目标接口的接口名字、接口编号、接口代号等可以指示具体接口的标识。

S120、根据目标接口标识，获取与目标接口相关联的目标参数信息、目标接口的接口信息以及接口地址。

与目标接口相关联的目标参数信息可以包括输入参数的相关信息和输出参数的相关信息，其中可以包括目标参数信息可以包括参数的字段长度、参数说明、备注等等。

接口信息是用于描述目标接口的相关信息，例如对该目标接口的描述以及说明的信息、该目标接口的名字、目标接口中所包含的不同方法等。目标接口的接口地址在进行接口代码确定时，即可根据一定的规则根据接口代码自动生成。

在一种实施例中，目标接口为SAP软件平台接口，S120包括如下步骤：

S120-1，根据目标接口标识，确定预先配置的目标参数信息库以及预先配置的目标接口信息库，其中，目标参数信息库和目标接口信息库通过SAP软件平台配置生成；

S120-2，从目标参数信息库中获取与目标接口相关联的目标参数信息，目标参数信息至少包括目标参数名以及目标参数类型；

S120-3，从目标接口信息库中获取目标接口的接口信息；

S120-4，根据目标接口标识，从地址数据库中获取目标接口的接口地址，地址数据库用于存储由SAP软件平台生成的接口地址。

由于在SAP软件平台上可以进行接口的开发，并且SAP软件平台具有针对接口的相关信息进行录入以及存储的功能，可以利用SAP软件平台的该功能进行参数信息库以及接口信息库的配置，根据不同的接口可以配置相对应的参数信息库以及接口信息库。

可以根据目标接口标识在SAP软件平台中多个参数信息库以及接口信息库中确定出目标参数信息库和目标接口信息库。

示例性的，目标参数类型可以是简单类型，例如字符型，数字型，日期型，金额类型，还可以是复杂类型，例如结构类型，也就是将某些字段串在一起形成一组数据，或者表类型则是将多条记录组织在一起。

在目标参数信息库中，可以存在多个目标参数，每个目标参数名分别对应该目标参数所属的目标参数类型。

在SAP软件平台针对目标接口完成开发后，会给自动为该目标接口生成接口地址，生成的接口地址会存储于地址数据库，可以根据目标接口标识，直接在地址数据库中获取目标接口的接口地址。

在一种实施例中，目标接口包含一个或多个接口方法，目标接口标识包括接口方法标识；根据目标接口标识，确定预先配置的目标参数信息库，包括如下步骤：

对目标接口标识中的所有接口方法标识进行遍历，并将当前遍历到的接口方法标识作为目标接口方法标识；

根据目标接口方法标识确定预先配置的目标参数信息库。

对于一个接口而言，可以完成多个事情，可以理解为具有多个功能，接口的每一个功能由接口的一个接口方法对应完成。为了让接口技术文档可以更好的展示每个接口方法的具体调用情况，可以根据接口方法对目标参数进行分类。对目标接口标识中的所有接口方法标识进行遍历，根据当前遍历的接口方法标识，可以确定目标参数信息库，完成所有接口方法标识的遍历后，可以得到目标接口中所有接口方法以及每个接口方法所对应的参数信息库。

当目标接口包含多个接口方法时，一个接口方法对应一个目标参数信息库，可以通过目标接口标识以及目标接口方法标识，共同确定具体的目标参数信息库。也就是说，一个目标接口可以与多个参数信息库具有关联关系。

在具体实现时，目标参数信息库可以分为目标输入参数信息库和目标输出参数信息库。

S130、根据目标参数信息确定目标接口的方法清单。

常见的接口方法可以包括以下几种：get(查)、post(增)，除此之外还有put(改)、delete(删)等。接口所包含的接口方法是由接口的业务、所具有的功能决定的。

每个方法清单用于展示相应的接口方法中所涉及的输入参数和输出参数的相关信息。

在确定目标参数信息后，可以把目标参数信息以表格的形式进行展示，该表格可以认为是方法清单。

当同一个接口具有多个接口方法，也就有多个相对应的参数信息库时，可以相应地有多个方法清单。其中，在利用目标参数信息填充方法清单时，还可以根据输入参数以及输出参数进行分类来填充，例如把方法清单归为输入参数信息部分以及输出参数信息部分，又或者是先将输入参数信息进行填充，在输入参数信息填充完毕后，再进行输出参数信息的填充，以使同一个接口的同一个方法中，在展示该方法的方法清单时，可以更清晰地展示各参数，不造成混乱。

S140、基于方法清单、接口地址以及接口信息，生成目标接口的接口技术文档。

可以通过得到的方法清单、接口地址以及接口信息一同进行展示，以形成接口技术文档。在另一种实现中，还可以预先设置一个通用的接口技术文档模板，在接口技术文档模板中将得到的方法清单、接口信息以及接口信息放置到对应的位置，以完成接口技术文档模板的填充，接口技术文档可以自动生成，无需耗费大量的劳动力进行人手编写，并且可以避免由于人手编写带来的编写错误等情况发生。

在一种实施例中，接口信息包括接口名称以及接口描述，方法清单包括一个或多个，S140包括如下步骤：

S140-1，将接口地址、接口名称以及接口描述作为接口技术文档的表头内容；

S140-2，将所有的方法清单以指定的排列方式展示于接口技术文档中。

在生成接口技术文档时，对于接口地址、接口名称以及接口描述等这些从接口层面与接口相关联的信息，可以作为接口技术文档的表头内容，在接口技术文档的开头部分进行展示，以介绍接口的基本情况。

从接口中所包含的各种参数而言，由于每个方法清单里包含了一个接口方法所涉及到的所有输入参数和输出参数，可以将每个方法清单按照指定的排列方式，在接口技术文档中进行独立的方法清单的展示。示例性的，方法清单中还可以包括接口方法标识，接口方法标识可以是接口方法名称，在展示方法清单时，把接口方法名称也一同展示，按照接口方法名称的字母顺序进行排列。

对于在方法清单中各参数的排列顺序，当目标参数信息库并没有分为目标输入参数信息库和目标输出参数信息库，则可以按照参数在目标参数信息库的顺序来决定参数在相应的方法清单中的顺序。当目标参数信息库分为目标输入参数信息库和目标输出参数信息库时，可以先按照目标输入参数信息库中输入参数的顺序来放进方法清单中，然后紧接着按照目标输出参数信息库中输出参数的顺序来放进该方法清单中。

在一种实施例中，目标接口信息库包括一个或多个接口方法名称以及一个或多个接口方法描述，其中，接口方法名称与接口方法描述一一对应，目标接口信息库通过如下方式配置生成：

提供接口信息录入界面，接口信息录入界面包括添加方法组件、接口方法名称输入组件以及接口方法描述组件；

获取并保存用户在同一接口信息录入界面中输入的接口方法名称以及接口方法描述；

当检测到添加方法组件被触发时，将接口方法名称输入组件以及接口方法描述组件进行清空，以使用户添加新的接口方法名称以及新的接口方法名称对应的接口方法描述；

根据保存的所有接口方法名称以及接口方法描述，生成目标接口信息库。

在对于目标接口信息库，可以有多个接口方法对应的接口方法名称，针对每一个接口方法名称，都可以有针对接口方法的接口方法描述，用于说明该接口方法的基本情况。参考图2的一种接口信息录入界面示意图，在具体实现中，接口方法描述组件可以包括短描述组件(如图2中的b位置)和长描述组件(如图2中的a位置)，短描述组件b和长描述组件a的主要区别在于可输入的规定字数不同。用户可以同时在短描述组件b和长描述组件a输入接口方法描述内容，如图2中a处的“Function Module Documentation”以及在b处的“GetMaterial Batch List”，也可以只输入其中的短描述组件b或长描述组件a，示例性的，当在短描述组件b中不足以描述清楚接口方法时，就可以在长描述组件a中输入内容，以作补充。

在提供的接口信息录入界面中，用户可以将接口方法名称(如图2中c位置)及其接口方法描述，按照每个接口方法的不同而分别输入。在每完成一个接口方法名称及其接口方法描述的输入后，若还有其他的接口方法，用户可以触发添加方法组件，在添加方法组件被触发后，可以将在先输入的接口方法名称及其接口方法描述进行保存，同时可以将接口方法名称输入组件以及接口方法描述组件中原来输入的内容进行清空，清空后用户可以根据下一接口方法名称及其接口方法描述继续进行输入。

在生成目标接口信息库时，可以通过先建立一个空的接口信息库，将用户输入至接口方法名称输入组件以及接口方法描述组件的内容实时添加至目标接口信息库中，以得到包含一个或多个接口方法以及接口方法对应的接口方法描述的目标接口信息库。为了便于确定当前的接口信息录入界面是在配置目标接口对应的目标接口信息库，可以在接口信息录入界面中同时显示目标接口的接口名称，如图2中的d所示。

在一种实施例中，根据目标参数信息确定目标接口的方法清单，包括如下步骤：

根据目标接口方法标识确定方法清单的模板，并从目标接口信息库中获取目标接口方法标识对应的接口方法描述；

获取模板中的各字段；

在目标参数信息中确定与模板中的各字段对应的目标字段，并获取目标字段对应的目标参数信息；

分别将目标字段对应的目标参数信息填入模板的对应字段下，并结合目标接口方法标识对应的接口方法描述，生成目标接口的方法清单。

方法清单的模板可以是对于所有接口方法通用的模板，示例性地，方法清单中可以有固定的字段，在确定方法清单模板中的字段时，可以将方法清单中固定的字段与目标参数信息中的字段进行匹配，通过模板中的字段从目标参数信息中确定目标字段，将目标参数信息中与目标字段相关联的内容放在方法清单的字段下，以将方法清单填充完整。模板中的各字段可以包括参数名、输入参数/输出参数、参数类型等等。

方法清单的模板也可以是根据不同的接口方法中需要展示的不同内容来预先设定的模板，在确定相应的模板后，可以先获取模板中的字段，再进行字段的匹配以及模板的填充等操作。

在一种实施例中，目标参数信息库采用如下方式配置生成：

提供参数信息录入界面，参数信息录入界面中包括参数类型录入组件以及参数命名组件；

获取用户在参数类型录入组件中输入的参数类型，作为目标参数类型，以及获取用户在参数命名组件中输入的参数名，作为目标参数名；

根据目标参数类型，在预先生成的数据库中进行匹配，数据库用于存储参数信息；

若匹配到数据库中存在目标参数类型，则将数据库中与目标参数类型相关联的所有参数信息，作为目标参数子信息；

根据目标参数名、目标参数类型以及目标参数子信息，生成目标参数信息库。

预先在数据库中根据不同的参数类型进行配置，可以根据参数类型，配置相应的字段名称、字段类型、长度、描述、说明等等内容作为与参数类型相关联的参数信息。示例性的，参考图3的一种数据库配置示意图，数据库可以有一个或多个，因此，数据库配置页面中可以通过配置数据量名称以作区分，如图3中的e位置显示的内容，即为该数据库名称。图3中f的位置则为数据库中的参数代号，相当于上述的参数类型。每个参数类型对应配置有相关参数信息，如图3中的g位置，g位置中可以有字段类型、字段长度等等针对参数进行限定的信息。另外，还可以针对每个参数类型进行描述说明，如图3中的h位置，就是对各参数类型进行描述的位置。

在生成目标参数信息库时，对于输入参数和输出参数的参数信息，可以在参数信息录入界面中参数类型录入组件确定目标参数类型后，在预先生成的数据库中匹配得到与目标参数类型相关联的参数信息，即用户每次在配置目标参数信息库时只需要输入目标参数名和目标参数类型，即可获取得到来自数据库的与该目标参数类型相关联的参数信息，大大减少了用户的劳动量。参考图4的一种目标参数信息库配置示意图，图4中j的位置供用户输入目标参数名，图4中k的位置供用户输入目标参数名对应的目标参数类型，在输入目标参数类型后，可以自动根据目标参数类型，从数据库中查找到与该目标参数类型的参数信息，并填充到图4的目标参数信息库的相应位置中，另外，为了可以令最后生成的接口技术文档内容更加丰富，除了从数据库中得到相应的参数描述以外，还可以在图4中的l位置进行额外的补充描述。在参数信息录入界面中同时可以显示目标接口的接口名称，如图4中的m位置所示。

在具体实现时，当数据库中没有匹配到与目标参数类型相同的参数类型，则可以发出提醒，以使用户在数据库中针对该参数类型的其他相关联参数信息进行录入。

在一种实现中，为了可以更加丰富接口技术文档的内容，对接口做更详细的说明，还可以获取接口代码中的注释内容，注释内容可以是在代码中每一个独立功能的位置处，增加对代码的描述。在获取注释内容后，将注释内容在接口技术文档中的指定位置进行展示，提高了接口技术文档的可读性，使用户对接口可以更容易理解。

本发明实施例提出一种接口技术文档的生成方法，该方法包括：接收针对接口技术文档的生成请求，生成请求包括目标接口标识，根据目标接口标识，获取与目标接口相关联的目标参数信息、目标接口的接口信息以及接口地址，根据目标参数信息确定目标接口的方法清单，基于方法清单、接口地址以及接口信息，生成目标接口的接口技术文档，实现自动生成接口技术文档，减少了用户手动编写接口技术文档的时间，提高了接口技术文档生成的效率，同时也提高了接口技术文档的可读性和正确率。

实施例二

图5为本发明实施例二提供的一种接口技术文档的生成装置的结构示意图，该装置包括：

生成请求接收模块510，用于接收针对接口技术文档的生成请求，所述生成请求包括目标接口标识；

获取模块520，用于根据所述目标接口标识，获取与目标接口相关联的目标参数信息、所述目标接口的接口信息以及接口地址；

方法清单确定模块530，用于根据所述目标参数信息确定所述目标接口的方法清单；

接口技术文档生成模块540，用于基于所述方法清单、所述接口地址以及所述接口信息，生成所述目标接口的接口技术文档。

在一种实施例中，所述接口信息包括接口名称以及接口描述，所述方法清单包括一个或多个；所述接口技术文档生成模块540，包括如下子模块：

表头内容确定子模块，用于将所述接口地址、所述接口名称以及所述接口描述作为所述接口技术文档的表头内容；

方法清单展示子模块，用于将所有的方法清单以指定的排列方式展示于所述接口技术文档中。

在一种实施例中，所述目标接口为SAP软件平台接口，所述获取模块520包括如下子模块：

确定子模块，用于根据所述目标接口标识，确定预先配置的目标参数信息库以及预先配置的目标接口信息库，其中，所述目标参数信息库和所述目标接口信息库通过SAP软件平台配置生成；

第一目标参数信息获取子模块，用于从所述目标参数信息库中获取与目标接口相关联的目标参数信息，所述目标参数信息至少包括目标参数名以及目标参数类型；

接口信息获取子模块，用于从所述目标接口信息库中获取所述目标接口的接口信息；

接口地址获取子模块，用于根据所述目标接口标识，从地址数据库中获取所述目标接口的接口地址，所述地址数据库用于存储由所述SAP软件平台生成的接口地址。

在一种实施例中，所述目标接口包含一个或多个接口方法，所述目标接口标识包括接口方法标识；所述确定子模块包括如下单元：

遍历单元，用于对所述目标接口标识中的所有接口方法标识进行遍历，并将当前遍历到的接口方法标识作为目标接口方法标识；

目标参数信息库确定单元，用于根据所述目标接口方法标识确定预先配置的目标参数信息库。

在一种实施例中，所述目标接口信息库包括一个或多个接口方法名称以及一个或多个接口方法描述，其中，所述接口方法名称与所述接口方法描述一一对应，所述装置还包括目标接口信息库配置模块，所述目标接口信息库配置模块包括如下子模块：

接口信息录入界面提供子模块，用于提供接口信息录入界面，所述接口信息录入界面包括添加方法组件、接口方法名称输入组件以及接口方法描述组件；

保存子模块，用于获取并保存用户在同一接口信息录入界面中输入的接口方法名称以及接口方法描述；

清空子模块，用于当检测到所述添加方法组件被触发时，将所述接口方法名称输入组件以及所述接口方法描述组件进行清空，以使用户添加新的接口方法名称以及新的接口方法名称对应的接口方法描述；

目标接口信息库生成子模块，用于根据保存的所有接口方法名称以及接口方法描述，生成所述目标接口信息库。

在一种实施例中，所述方法清单确定模块530，包括如下子模块：

模板确定子模块，用于根据所述目标接口方法标识确定方法清单的模板，并从所述目标接口信息库中获取所述目标接口方法标识对应的接口方法描述；

字段获取子模块，用于获取所述模板中的各字段；

第二目标参数信息获取子模块，用于在所述目标参数信息中确定与所述模板中的各字段对应的目标字段，并获取所述目标字段对应的目标参数信息；

方法清单生成子模块，用于分别将所述目标字段对应的目标参数信息填入所述模板的对应字段下，并结合所述目标接口方法标识对应的接口方法描述，生成所述目标接口的方法清单。

在一种实施例中，所述装置包括目标参数信息库配置模块，所述目标参数信息库配置模块包括如下子模块：

参数信息录入界面提供子模块，用于提供参数信息录入界面，所述参数信息录入界面中包括参数类型录入组件以及参数命名组件；

目标参数类型获取子模块，用于获取用户在所述参数类型录入组件中输入的参数类型，作为目标参数类型；

目标参数名获取子模块，用于获取用户在所述参数命名组件中输入的参数名，作为目标参数名；

匹配子模块，用于根据所述目标参数类型，在预先生成的数据库中进行匹配，所述数据库用于存储参数信息；

目标参数子信息确定子模块，用于当匹配到所述数据库中存在所述目标参数类型，则将所述数据库中与所述目标参数类型相关联的所有参数信息，作为目标参数子信息；

目标参数信息库生成子模块，用于根据所述目标参数名、所述目标参数类型以及所述目标参数子信息，生成所述目标参数信息库。

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

实施例三

图6示出了可以用来实施本发明的实施例的电子设备10的结构示意图。电子设备旨在表示各种形式的数字计算机，诸如，膝上型计算机、台式计算机、工作台、个人数字助理、服务器、刀片式服务器、大型计算机、和其它适合的计算机。电子设备还可以表示各种形式的移动装置，诸如，个人数字处理、蜂窝电话、智能电话、可穿戴设备(如头盔、眼镜、手表等)和其它类似的计算装置。本文所示的部件、它们的连接和关系、以及它们的功能仅仅作为示例，并且不意在限制本文中描述的和/或者要求的本发明的实现。

如图6所示，电子设备10包括至少一个处理器11，以及与至少一个处理器11通信连接的存储器，如只读存储器(ROM)12、随机访问存储器(RAM)13等，其中，存储器存储有可被至少一个处理器执行的计算机程序，处理器11可以根据存储在只读存储器(ROM)12中的计算机程序或者从存储单元18加载到随机访问存储器(RAM)13中的计算机程序，来执行各种适当的动作和处理。在RAM13中，还可存储电子设备10操作所需的各种程序和数据。处理器11、ROM12以及RAM13通过总线14彼此相连。输入/输出(I/O)接口15也连接至总线14。

电子设备10中的多个部件连接至I/O接口15，包括：输入单元16，例如键盘、鼠标等；输出单元17，例如各种类型的显示器、扬声器等；存储单元18，例如磁盘、光盘等；以及通信单元19，例如网卡、调制解调器、无线通信收发机等。通信单元19允许电子设备10通过诸如因特网的计算机网络和/或各种电信网络与其他设备交换信息/数据。

处理器11可以是各种具有处理和计算能力的通用和/或专用处理组件。处理器11的一些示例包括但不限于中央处理单元(CPU)、图形处理单元(GPU)、各种专用的人工智能(AI)计算芯片、各种运行机器学习模型算法的处理器、数字信号处理器(DSP)、以及任何适当的处理器、控制器、微控制器等。处理器11执行上文所描述的各个方法和处理，例如一种接口技术文档的生成方法。

在一些实施例中，一种接口技术文档的生成方法可被实现为计算机程序，其被有形地包含于计算机可读存储介质，例如存储单元18。在一些实施例中，计算机程序的部分或者全部可以经由ROM12和/或通信单元19而被载入和/或安装到电子设备10上。当计算机程序加载到RAM13并由处理器11执行时，可以执行上文描述的一种接口技术文档的生成方法的一个或多个步骤。备选地，在其他实施例中，处理器11可以通过其他任何适当的方式(例如，借助于固件)而被配置为执行一种接口技术文档的生成方法。

本文中以上描述的系统和技术的各种实施方式可以在数字电子电路系统、集成电路系统、场可编程门阵列(FPGA)、专用集成电路(ASIC)、专用标准产品(ASSP)、芯片上系统的系统(SOC)、负载可编程逻辑设备(CPLD)、计算机硬件、固件、软件、和/或它们的组合中实现。这些各种实施方式可以包括：实施在一个或者多个计算机程序中，该一个或者多个计算机程序可在包括至少一个可编程处理器的可编程系统上执行和/或解释，该可编程处理器可以是专用或者通用可编程处理器，可以从存储系统、至少一个输入装置、和至少一个输出装置接收数据和指令，并且将数据和指令传输至该存储系统、该至少一个输入装置、和该至少一个输出装置。

用于实施本发明的方法的计算机程序可以采用一个或多个编程语言的任何组合来编写。这些计算机程序可以提供给通用计算机、专用计算机或其他可编程数据处理装置的处理器，使得计算机程序当由处理器执行时使流程图和/或框图中所规定的功能/操作被实施。计算机程序可以完全在机器上执行、部分地在机器上执行，作为独立软件包部分地在机器上执行且部分地在远程机器上执行或完全在远程机器或服务器上执行。

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

为了提供与用户的交互，可以在电子设备上实施此处描述的系统和技术，该电子设备具有：用于向用户显示信息的显示装置(例如，CRT(阴极射线管)或者LCD(液晶显示器)监视器)；以及键盘和指向装置(例如，鼠标或者轨迹球)，用户可以通过该键盘和该指向装置来将输入提供给电子设备。其它种类的装置还可以用于提供与用户的交互；例如，提供给用户的反馈可以是任何形式的传感反馈(例如，视觉反馈、听觉反馈、或者触觉反馈)；并且可以用任何形式(包括声输入、语音输入或者、触觉输入)来接收来自用户的输入。

可以将此处描述的系统和技术实施在包括后台部件的计算系统(例如，作为数据服务器)、或者包括中间件部件的计算系统(例如，应用服务器)、或者包括前端部件的计算系统(例如，具有图形用户界面或者网络浏览器的用户计算机，用户可以通过该图形用户界面或者该网络浏览器来与此处描述的系统和技术的实施方式交互)、或者包括这种后台部件、中间件部件、或者前端部件的任何组合的计算系统中。可以通过任何形式或者介质的数字数据通信(例如，通信网络)来将系统的部件相互连接。通信网络的示例包括：局域网(LAN)、广域网(WAN)、区块链网络和互联网。

计算系统可以包括客户端和服务器。客户端和服务器一般远离彼此并且通常通过通信网络进行交互。通过在相应的计算机上运行并且彼此具有客户端-服务器关系的计算机程序来产生客户端和服务器的关系。服务器可以是云服务器，又称为云计算服务器或云主机，是云计算服务体系中的一项主机产品，以解决了传统物理主机与VPS服务中，存在的管理难度大，业务扩展性弱的缺陷。

应该理解，可以使用上面所示的各种形式的流程，重新排序、增加或删除步骤。例如，本发明中记载的各步骤可以并行地执行也可以顺序地执行也可以不同的次序执行，只要能够实现本发明的技术方案所期望的结果，本文在此不进行限制。

上述具体实施方式，并不构成对本发明保护范围的限制。本领域技术人员应该明白的是，根据设计要求和其他因素，可以进行各种修改、组合、子组合和替代。任何在本发明的精神和原则之内所作的修改、等同替换和改进等，均应包含在本发明保护范围之内。

Claims (8)

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

接收针对接口技术文档的生成请求，所述生成请求包括目标接口标识；

根据所述目标接口标识，获取与目标接口相关联的目标参数信息、所述目标接口的接口信息以及接口地址，所述接口信息包括接口名称以及接口描述；

根据所述目标参数信息确定所述目标接口的方法清单，所述方法清单用于展示所述目标接口对应的接口方法中所涉及的输入参数和输出参数的相关信息，所述方法清单包括一个或多个；

将所述接口地址、所述接口名称以及所述接口描述作为接口技术文档的表头内容；

将所有的方法清单以指定的排列方式展示于所述接口技术文档中；

其中，所述目标接口为SAP软件平台接口，所述根据所述目标接口标识，获取与目标接口相关联的目标参数信息、所述目标接口的接口信息以及接口地址，包括：

根据所述目标接口标识，确定预先配置的目标参数信息库以及预先配置的目标接口信息库，其中，所述目标参数信息库和所述目标接口信息库通过SAP软件平台配置生成；

从所述目标参数信息库中获取与目标接口相关联的目标参数信息，所述目标参数信息至少包括目标参数名以及目标参数类型；

从所述目标接口信息库中获取所述目标接口的接口信息；

根据所述目标接口标识，从地址数据库中获取所述目标接口的接口地址，所述地址数据库用于存储由所述SAP软件平台生成的接口地址。

2.根据权利要求1所述的方法，其特征在于，所述目标接口包含一个或多个接口方法，所述目标接口标识包括接口方法标识；所述根据所述目标接口标识，确定预先配置的目标参数信息库，包括：

对所述目标接口标识中的所有接口方法标识进行遍历，并将当前遍历到的接口方法标识作为目标接口方法标识；

根据所述目标接口方法标识确定预先配置的目标参数信息库。

3.根据权利要求2所述的方法，其特征在于，所述目标接口信息库包括一个或多个接口方法名称以及一个或多个接口方法描述，其中，所述接口方法名称与所述接口方法描述一一对应，所述目标接口信息库通过如下方式配置生成：

提供接口信息录入界面，所述接口信息录入界面包括添加方法组件、接口方法名称输入组件以及接口方法描述组件；

获取并保存用户在同一接口信息录入界面中输入的接口方法名称以及接口方法描述；

当检测到所述添加方法组件被触发时，将所述接口方法名称输入组件以及所述接口方法描述组件进行清空，以使用户添加新的接口方法名称以及新的接口方法名称对应的接口方法描述；

根据保存的所有接口方法名称以及接口方法描述，生成所述目标接口信息库。

4.根据权利要求3所述的方法，其特征在于，所述根据所述目标参数信息确定所述目标接口的方法清单，包括：

根据所述目标接口方法标识确定方法清单的模板，并从所述目标接口信息库中获取所述目标接口方法标识对应的接口方法描述；

获取所述模板中的各字段；

在所述目标参数信息中确定与所述模板中的各字段对应的目标字段，并获取所述目标字段对应的目标参数信息；

分别将所述目标字段对应的目标参数信息填入所述模板的对应字段下，并结合所述目标接口方法标识对应的接口方法描述，生成所述目标接口的方法清单。

5.根据权利要求1-4任一所述的方法，其特征在于，目标参数信息库采用如下方式配置生成：

提供参数信息录入界面，所述参数信息录入界面中包括参数类型录入组件以及参数命名组件；

获取用户在所述参数类型录入组件中输入的参数类型，作为目标参数类型，以及获取用户在所述参数命名组件中输入的参数名，作为目标参数名；

根据所述目标参数类型，在预先生成的数据库中进行匹配，所述数据库用于存储参数信息；

若匹配到所述数据库中存在所述目标参数类型，则将所述数据库中与所述目标参数类型相关联的所有参数信息，作为目标参数子信息；

根据所述目标参数名、所述目标参数类型以及所述目标参数子信息，生成所述目标参数信息库。

6.一种接口技术文档的生成装置，其特征在于，所述装置包括：

生成请求接收模块，用于接收针对接口技术文档的生成请求，所述生成请求包括目标接口标识；

获取模块，用于根据所述目标接口标识，获取与目标接口相关联的目标参数信息、所述目标接口的接口信息以及接口地址，所述接口信息包括接口名称以及接口描述；

方法清单确定模块，用于根据所述目标参数信息确定所述目标接口的方法清单，所述方法清单用于展示所述目标接口对应的接口方法中所涉及的输入参数和输出参数的相关信息，所述方法清单包括一个或多个；

接口技术文档生成模块，用于基于所述方法清单、所述接口地址以及所述接口信息，生成所述目标接口的接口技术文档，包括：

表头内容确定子模块，用于将所述接口地址、所述接口名称以及所述接口描述作为所述接口技术文档的表头内容；

方法清单展示子模块，用于将所有的方法清单以指定的排列方式展示于所述接口技术文档中；

其中，所述目标接口为SAP软件平台接口，所述获取模块包括如下子模块：

确定子模块，用于根据所述目标接口标识，确定预先配置的目标参数信息库以及预先配置的目标接口信息库，其中，所述目标参数信息库和所述目标接口信息库通过SAP软件平台配置生成；

第一目标参数信息获取子模块，用于从所述目标参数信息库中获取与目标接口相关联的目标参数信息，所述目标参数信息至少包括目标参数名以及目标参数类型；

接口信息获取子模块，用于从所述目标接口信息库中获取所述目标接口的接口信息；

接口地址获取子模块，用于根据所述目标接口标识，从地址数据库中获取所述目标接口的接口地址，所述地址数据库用于存储由所述SAP软件平台生成的接口地址。

7.一种电子设备，其特征在于，所述电子设备包括：

至少一个处理器；以及与所述至少一个处理器通信连接的存储器；其中，所述存储器存储有可被所述至少一个处理器执行的计算机程序，所述计算机程序被所述至少一个处理器执行，以使所述至少一个处理器能够执行权利要求1-5中任一所述的一种接口技术文档的生成方法。

8.一种计算机可读存储介质，其特征在于，所述计算机可读存储介质存储有计算机指令，所述计算机指令用于使处理器执行时实现权利要求1-5中任一所述的一种接口技术文档的生成方法。

Images