CN107766040A - 一种生成接口文档的方法、装置及计算机可读存储介质 - Google Patents
一种生成接口文档的方法、装置及计算机可读存储介质 Download PDFInfo
- Publication number
- CN107766040A CN107766040A CN201710846088.2A CN201710846088A CN107766040A CN 107766040 A CN107766040 A CN 107766040A CN 201710846088 A CN201710846088 A CN 201710846088A CN 107766040 A CN107766040 A CN 107766040A
- Authority
- CN
- China
- Prior art keywords
- interface
- document
- parameter
- verified
- data
- 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
Classifications
-
- 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/31—Programming languages or programming paradigms
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F40/00—Handling natural language data
- G06F40/10—Text processing
- G06F40/166—Editing, e.g. inserting or deleting
- G06F40/186—Templates
Landscapes
- Engineering & Computer Science (AREA)
- Theoretical Computer Science (AREA)
- General Engineering & Computer Science (AREA)
- Software Systems (AREA)
- Physics & Mathematics (AREA)
- General Physics & Mathematics (AREA)
- General Health & Medical Sciences (AREA)
- Health & Medical Sciences (AREA)
- Computational Linguistics (AREA)
- Audiology, Speech & Language Pathology (AREA)
- Computing Systems (AREA)
- Artificial Intelligence (AREA)
- Stored Programmes (AREA)
Abstract
本发明涉及数据处理技术领域，公开了一种生成接口文档的方法、装置及计算机可读存储介质。其中方法包括：若接收到用于访问第一接口的第一接口文档的请求，则获取所述第一接口对应的第一接口数据，所述第一接口数据根据已注解的第一接口程序生成；对所述第一接口数据进行解析，得到所述第一接口的属性信息；将所述第一接口的属性信息对应添加至预设的接口文档模板中，得到所述第一接口文档，并显示所述第一接口文档。本发明实施例不仅能够节省人力，而且生成的接口文档的格式统一，便于其他开发人员阅读，同时还能保证接口文档与接口属性的一致性。
Description
技术领域
本发明涉及数据处理技术领域，尤其涉及一种生成接口文档的方法、装置及计算机可读存储介质。
背景技术
同一系统不同功能层之间的通信规则称为接口。接口文档用于描述接口的属性，例如描述接口的输入参数的格式、输出参数的格式或通信协议等。通常，在一个接口开发完成后，开发人员会编写一份与接口对应的接口文档，以便其他开发人员能够通过接口文档清楚地了解相应的接口。
现有的接口文档需要开发人员自行编写，费时费力；且不同的开发人员所编写的接口文档的格式不统一，不便于其他开发人员阅读；同时，由于接口和接口文档是分开编写的，因此经常会出现接口文档与接口属性不一致的现象。
发明内容
本发明实施例提供一种生成接口文档的方法、装置及计算机可读存储介质，旨在解决现有的人工编写接口文档的方法所存在的费时费力，不同开发人员编写的接口文档的格式不统一，接口文档与接口属性不一致的问题。
第一方面，本实施例提供了一种生成接口文档的方法，该方法包括：
若接收到用于访问第一接口的第一接口文档的请求，则获取所述第一接口对应的第一接口数据，所述第一接口数据根据已注解的第一接口程序生成；
对所述第一接口数据进行解析，得到所述第一接口的属性信息；
将所述第一接口的属性信息对应添加至预设的接口文档模板中，得到所述第一接口文档，并显示所述第一接口文档。
第二方面，本实施例提供了一种生成接口文档的装置，该装置包括：
第一获取单元，用于若接收到用于访问第一接口的第一接口文档的请求，则获取所述第一接口对应的第一接口数据，所述第一接口数据根据已注解的第一接口程序生成；
解析单元，用于对所述第一接口数据进行解析，得到所述第一接口的属性信息；
文档生成单元，用于将所述第一接口的属性信息对应添加至预设的接口文档模板中，得到所述第一接口文档，并显示所述第一接口文档。
第三方面，本实施例提供了一种生成接口文档的装置，包括存储器、处理器以及存储在所述存储器中并可在所述处理器上运行的计算机程序，所述处理器执行所述计算机程序时实现如上述第一方面所述方法的步骤。
第四方面，本实施例提供了一种计算机可读存储介质，所述计算机可读存储介质存储有计算机程序，所述计算机程序被处理器执行时实现如上述第一方面所述方法的步骤。
本发明实施例通过若接收到用于访问第一接口的第一接口文档的请求，则获取所述第一接口对应的第一接口数据，所述第一接口数据根据已注解的第一接口程序生成；对所述第一接口数据进行解析，得到所述第一接口的属性信息；将所述第一接口的属性信息对应添加至预设的接口文档模板中，得到所述第一接口文档，并显示所述第一接口文档。如此，开发人员只需在编写接口程序时对接口程序进行相应的注解，本发明实施例便可根据已注解的接口程序生成预设格式的接口文档，不仅节省了人力，而且生成的接口文档的格式统一，便于其他开发人员阅读；同时，由于接口文档是根据与接口程序对应的接口数据自动生成的，而非人为编写的，因此保证了接口文档与接口属性的一致性。
附图说明
为了更清楚地说明本发明实施例中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动性的前提下，还可以根据这些附图获得其他的附图。
图1是本发明实施例提供的一种生成接口文档的方法的流程图；
图2是本发明另一实施例提供的一种生成接口文档的方法的流程图；
图3是本发明实施例提供的一种生成接口文档的装置的结构图；
图4是本发明另一实施例提供的一种生成接口文档的装置的结构图；
图5是本发明再一实施例提供的一种生成接口文档的装置的结构图。
具体实施方式
为了使本发明的目的、技术方案及优点更加清楚明白，以下结合附图及实施例，对本发明进行进一步详细说明。应当理解，此处所描述的具体实施例仅仅用以解释本发明，并不用于限定本发明。
参见图1，图1是本发明实施例提供的一种生成接口文档的方法的示意流程图。本实施例中生成接口文档的方法的执行主体为生成接口文档的装置，生成接口文档的装置可以为终端设备，终端设备可以为手机、平板电脑、台式电脑等设备，此处不做限制。如图1所示的生成接口文档的方法可以包括以下步骤：
S11：若接收到用于访问第一接口的第一接口文档的请求，则获取所述第一接口对应的第一接口数据，所述第一接口数据根据已注解的第一接口程序生成。
在本发明实施例中，第一接口可以为已开发完成的任一应用程序编程接口(Application Programming Interface，API)，API可以实现同一系统不同功能层之间的相互通信。通常，开发人员可根据实际需求开发各种用于实现不同功能的接口。可以理解的是，开发人员在开发接口(即编写接口程序)时，可以对接口程序进行相应的注解，以为后续根据已注解的接口程序生成相应的接口文档提供基础。
在本发明实施例中，对接口程序进行注解具体指，对接口的属性信息进行标注和解释。接口的属性信息包括但不限于接口的名称、接口的统一资源定位符(UniformResource Locator，URL)、接口的输入参数的名称、接口的输入参数的类型、接口的输出参数的名称及接口的输出参数的类型等。
开发人员可以根据预设的注解方式对接口程序进行注解。预设的注解方式可以根据实际需求设置，此处不做限制。例如，预设的注解方式可以为Hibernate Validator注解工具，或者，预设的注解方式可以为开发人员自定义的注解方式。
在本发明实施例中，当用户(例如开发人员)有查看第一接口对应的第一接口文档的需求时，其可以通过终端设备输入用于访问第一接口的第一接口文档的请求。终端设备若接收到用于访问第一接口的第一接口文档的请求，则获取第一接口对应的第一接口数据。
其中，第一接口数据根据已注解的第一接口程序生成，第一接口数据用于描述第一接口的属性信息，且第一接口数据为预设格式的数据。预设格式可以根据实际需求设置，此处不做限制。例如，预设格式可以为Java脚本对象标记(JavaScript Object Notation，JSON)格式，JSON格式是轻量级的文本数据交换格式，其使用Java脚本语法来描述数据对象，更易理解。终端可以预先通过JSON解析器将已注解的第一接口程序转换为相应的JSON格式的第一接口数据，并将第一接口对应的第一接口数据存储至本地。终端设备在接收到用于访问第一接口的第一接口文档的请求时，可以从本地获取第一接口对应的第一接口数据。
S12：对所述第一接口数据进行解析，得到所述第一接口的属性信息。
终端设备获取到第一接口对应的第一接口数据后，对第一接口数据进行解析，得到第一接口的属性信息。
具体的，终端设备可以根据与第一接口数据的格式对应的解析方式对第一接口数据进行解析。例如，若第一接口数据为JSON格式的数据，则终端设备可以采用JSON解析器对第一接口数据进行解析，对第一接口数据进行解析后即得到第一接口的属性信息。
S13：将所述第一接口的属性信息对应添加至预设的接口文档模板中，得到所述第一接口文档，并显示所述第一接口文档。
终端设备对第一接口数据进行解析得到第一接口对应的属性信息后，将第一接口的属性信息对应添加至预设的接口文档模板中，得到第一接口对应的第一接口文档。
其中，预设的接口文档模板可以根据实际需求设置，此处不做限制。
终端设备得到第一接口对应的第一接口文档后，将第一接口文档进行显示，以便用户对第一接口文档进行查看。
以上可以看出，本实施例提供的一种生成接口文档的方法通过若接收到用于访问第一接口的第一接口文档的请求，则获取所述第一接口对应的第一接口数据，所述第一接口数据根据已注解的第一接口程序生成；对所述第一接口数据进行解析，得到所述第一接口的属性信息；将所述第一接口的属性信息对应添加至预设的接口文档模板中，得到所述第一接口文档，并显示所述第一接口文档。如此，开发人员只需在编写接口程序时对接口程序进行相应的注解，本发明实施例便可根据已注解的接口程序生成预设格式的接口文档，不仅节省了人力，而且生成的接口文档的格式统一，便于其他开发人员阅读；同时，由于接口文档是根据与接口程序对应的接口数据自动生成的，而非人为编写的，因此保证了接口文档与接口属性的一致性。
参见图2，图2是本发明另一实施例提供的一种生成接口文档的方法的示意流程图。本实施例中生成接口文档的方法的执行主体为生成接口文档的装置，生成接口文档的装置可以为终端设备，终端设备可以为手机、平板电脑、台式电脑等设备，此处不做限制。如图2所示的生成接口文档的方法可以包括以下步骤：
S21：若接收到用于访问第一接口的第一接口文档的请求，则获取所述第一接口对应的第一接口数据，所述第一接口数据根据已注解的第一接口程序生成。
需要说明的是，本实施例中的S21与第一实施例的S11相同，具体请参阅第一实施例中S11的具体描述，此处不赘述。
在本实施例中，在S21之前，生成接口文档的方法可以包括以下步骤：
获取第一接口对应的已注解的第一接口程序；
根据所述已注解的第一接口程序以及预设的接口数据生成策略，生成与所述第一接口对应的第一接口数据。
在本实施例中，终端设备可以在检测到用户启动与第一接口对应的应用程序时，获取第一接口对应的已注解的第一接口程序，并根据已注解的第一接口程序以及预设的接口数据生成策略，生成与第一接口对应的第一接口数据。
其中，预设的接口数据生成策略可以根据实际需求设置，此处不做限制。例如，若要生成的第一接口数据为JSON格式的数据，则预设的接口数据生成策略可以为与JSON格式的数据对应的数据生成策略。
可以理解的是，终端设备生成第一接口数据后，可以将第一接口数据存储至本地，使得用户每次需要查看接口文档时，终端设备可以直接从本地获取并解析第一接口数据，进而生成与第一接口对应的接口文档。
S22：对所述第一接口数据进行解析，得到所述第一接口的属性信息。
终端设备获取到第一接口对应的第一接口数据后，对第一接口数据进行解析，得到第一接口的属性信息。
具体的，终端设备可以根据与第一接口数据的格式对应的解析方式对第一接口数据进行解析。例如，若第一接口数据为JSON格式的数据，则终端设备可以采用JSON解析器对第一接口数据进行解析，对第一接口数据进行解析后即得到第一接口的属性信息。
S23：将所述第一接口的属性信息对应添加至预设的接口文档模板中，得到所述第一接口文档，并显示所述第一接口文档。
终端设备对第一接口数据进行解析得到第一接口对应的属性信息后，将第一接口的属性信息对应添加至预设的接口文档模板中，得到第一接口对应的第一接口文档。
其中，预设的接口文档模板可以根据实际需求设置，此处不做限制。
终端设备得到第一接口对应的第一接口文档后，将第一接口文档进行显示，以便用户对第一接口文档进行查看。
S24：若接收到用于调用第一接口的接口调用请求，则获取所述第一接口的待校验参数对应的校验策略。
S25：根据所述待校验参数对应的校验策略，对所述接口调用请求携带的所述待校验参数的参数值进行校验。
在本实施例中，开发人员可以根据实际需求来确定是否需要对接口的某些参数进行校验。例如，若第一接口的第一输入参数为身份证号码，则开发人员可以设置第一输入参数需要进行校验。
具体的，开发人员可以在对接口程序进行注解时，通过校验标识来表示接口被调用时接口参数是否需要进行校验。例如，开发人员可以设置待校验参数对应的校验标识为1，不需要校验的参数对应的校验标识为0。且开发人员可以为每个待校验参数配置相应的校验策略，即开发人员可以设置待校验参数与校验策略之间的预设对应关系。例如，若第一接口的第一参数为身份证号码，则开发人员可以设置第一参数对应的校验策略为：第一输入参数的参数值必须为15位或18位，且第一参数的参数值中包含的元素必须为数字或X。
终端设备可以将待校验参数与校验策略之间的预设对应关系进行存储。
终端设备正常工作时，若接收到用于调用第一接口的接口调用请求，则确定第一接口的待校验参数，并获取第一接口的待校验参数对应的校验策略。同时，终端还获取接口调用请求携带的待校验参数的参数值，并根据待校验参数对应的校验策略，对接口调用请求携带的所述待校验参数的参数值进行校验。
具体的，S24可以包括S241～S242。
S241：若接收到用于调用第一接口的接口调用请求，则根据已注解的第一接口程序，确定所述第一接口的待校验参数。
S242：获取所述待校验参数对应的校验策略。
由于研发人员在对接口程序进行注解时，通过校验标识来标识第一接口的接口参数是否需要进行校验。因此，终端在接收到用于调用第一接口的接口调用请求时，可以根据已注解的第一接口程序来确定第一接口的待校验参数。
例如，终端可以确定校验标识为1的参数为待校验参数，校验标识为0的参数为不需要校验的参数。
终端确定了第一接口的待校验参数后，可以获取待校验参数与校验策略之间的预设对应关系，并根据待校验参数与校验策略之间的预设对应关系确定待校验参数对应的校验策略。
或者，开发人员可以预先设置参数的注解类型与校验策略之间的预设对应关系。不同的注解类型可以对应不同的校验策略。例如，若某一参数对应的注解类型为数字，则该参数对应的校验策略可以为：参数值必须为数字。
终端将参数的注解类型与校验策略之间的预设对应关系进行存储。
进一步的，S242可以包括以下步骤：
根据所述已注解的第一接口程序，确定所述待校验参数对应的注解类型；
根据注解类型与检验策略之间的预设对应关系，确定所述待校验参数对应的校验策略。
终端确定了第一接口的待校验参数后，可以根据已注解的第一接口程序，确定待校验参数对应的注解类型，并根据注解类型与检验策略之间的预设对应关系，确定待校验参数对应的校验策略。
需要说明的是，本实施例中的S21～S23与S24～S25为并列步骤。
以上可以看出，本实施例提供的一种生成接口文档的方法可根据已注解的接口程序生成预设格式的接口文档，不仅节省了人力，而且生成的接口文档的格式统一，便于其他开发人员阅读；同时，由于接口文档是根据与接口程序对应的接口数据自动生成的，而非人为编写的，因此保证了接口文档与接口属性的一致性。由于预先存储了待校验参数与校验策略之间的预设对应关系，因此，当接口新增参数时，开发人员只需配置新增参数对应的校验策略即可，而无需对已存储的参数对应的校验策略进行配置，减小了工作量。
参见图3，图3是本发明实施例提供的一种生成接口文档的装置的结构图。生成接口文档的装置可以为终端设备，终端设备可以为手机、平板电脑、台式电脑等设备，此处不做限制。本实施例的生成接口文档的装置300包括的各单元用于执行图1对应的实施例中的各步骤，具体请参阅图1及图1对应的实施例中的相关描述，此处不赘述。本实施例的生成接口文档的装置300包括第一获取单元301、解析单元302及文档生成单元303。
第一获取单元301用于若接收到用于访问第一接口的第一接口文档的请求，则获取所述第一接口对应的第一接口数据，所述第一接口数据根据已注解的第一接口程序生成。第一获取单元301将第一接口数据发送至解析单元302。
解析单元302用于接收第一获取单元301发送的第一接口数据，对所述第一接口数据进行解析，得到所述第一接口的属性信息。解析单元302将第一接口的属性信息发送至文档生成单元303。
文档生成单元303用于接收解析单元302发送的第一接口的属性信息，将所述第一接口的属性信息对应添加至预设的接口文档模板中，得到所述第一接口文档，并显示所述第一接口文档。
以上可以看出，本实施例提供的一种生成接口文档的装置通过若接收到用于访问第一接口的第一接口文档的请求，则获取所述第一接口对应的第一接口数据，所述第一接口数据根据已注解的第一接口程序生成；对所述第一接口数据进行解析，得到所述第一接口的属性信息；将所述第一接口的属性信息对应添加至预设的接口文档模板中，得到所述第一接口文档，并显示所述第一接口文档。如此，开发人员只需在编写接口程序时对接口程序进行相应的注解，本发明实施例便可根据已注解的接口程序生成预设格式的接口文档，不仅节省了人力，而且生成的接口文档的格式统一，便于其他开发人员阅读；同时，由于接口文档是根据与接口程序对应的接口数据自动生成的，而非人为编写的，因此保证了接口文档与接口属性的一致性。
参见图4，图4是本发明实施例提供的一种生成接口文档的装置的结构图。本实施例的生成接口文档的装置400包括的各单元用于执行图2对应的实施例中的各步骤，具体请参阅图2及图2对应的实施例中的相关描述，此处不赘述。本实施例的生成接口文档的装置400包括第一获取单元401、解析单元402、文档生成单元403、第二获取单元404及参数校验单元405。
第一获取单元401用于若接收到用于访问第一接口的第一接口文档的请求，则获取所述第一接口对应的第一接口数据，所述第一接口数据根据已注解的第一接口程序生成。第一获取单元401将第一接口数据发送至解析单元402。
解析单元402用于接收第一获取单元401发送的第一接口数据，对所述第一接口数据进行解析，得到所述第一接口的属性信息。解析单元402将第一接口的属性信息发送至文档生成单元403。
文档生成单元403用于接收解析单元402发送的第一接口的属性信息，将所述第一接口的属性信息对应添加至预设的接口文档模板中，得到所述第一接口文档，并显示所述第一接口文档。
第二获取单元404用于若接收到用于调用第一接口的接口调用请求，则获取所述第一接口的待校验参数对应的校验策略。第二获取单元404将第一接口的待校验参数对应的校验策略发送至参数校验单元405。
参数校验单元405用于接收第二获取单元404发送的第一接口的待校验参数对应的校验策略，根据所述待校验参数对应的校验策略，对所述接口调用请求携带的所述待校验参数的参数值进行校验。
可选的，终端400还可以包括接口程序获取单元和接口数据生成单元。
接口程序获取单元用于获取第一接口对应的已注解的第一接口程序。接口程序获取单元将已注解的第一接口程序发送至接口数据生成单元。
接口数据生成单元用于接收接口程序获取单元发送的已注解的第一接口程序，根据所述已注解的第一接口程序以及预设的接口数据生成策略，生成与所述第一接口对应的第一接口数据。接口数据生成单元将第一接口对应的第一接口数据发送至第一获取单元401。
可选的，第二获取单元404可以包括第一确定单元4041和校验策略获取单元4042。
第一确定单元4041用于若接收到用于调用第一接口的接口调用请求，则根据已注解的第一接口程序，确定所述第一接口的待校验参数。第一确定单元4041将第一接口的待校验参数发送至校验策略获取单元4042。
校验策略获取单元4042用于接收第一确定单元发送的第一接口的待校验参数，获取所述待校验参数对应的校验策略。
进一步的，检验策略获取单元4042具体用于：根据所述已注解的第一接口程序，确定所述待校验参数对应的注解类型；根据注解类型与检验策略之间的预设对应关系，确定所述待校验参数对应的校验策略。
以上可以看出，本实施例提供的一种生成接口文档的装置可根据已注解的接口程序生成预设格式的接口文档，不仅节省了人力，而且生成的接口文档的格式统一，便于其他开发人员阅读；同时，由于接口文档是根据与接口程序对应的接口数据自动生成的，而非人为编写的，因此保证了接口文档与接口属性的一致性。由于预先存储了待校验参数与校验策略之间的预设对应关系，因此，当接口新增参数时，开发人员只需配置新增参数对应的校验策略即可，而无需对已存储的参数对应的校验策略进行配置，减小了工作量。
参见图5，图5是本发明再一实施例提供的一种生成接口文档的装置的示意图。如图5所示的本实施例中的生成接口文档的装置500可以包括：处理器501、存储器502以及存储在存储器502中并可在处理器501上运行的计算机程序503，例如配置车辆诊断参数的程序。处理器501执行计算机程序503时实现上述各个生成接口文档的方法实施例中的步骤。例如图1所示的S11至S13。或者，处理器501执行计算机程序503时实现上述各设备实施例中各单元的功能，例如图3所述的单元301至303。
示例性的，计算机程序503可以被分割成一个或多个单元，所述一个或者多个单元被存储在所述存储器502中，并由所述处理器501执行，以完成本发明。所述一个或多个单元可以是能够完成特定功能的一系列计算机程序指令段，该指令段用于描述所述计算机程序503在生成接口文档的装置500中的执行过程。例如，所述计算机程序503可以被分割成第一获取单元、解析单元、文档生成单元、接口程序获取单元、接口数据生成单元、第二获取单元及参数校验单元，各单元具体功能如下：
第一获取单元用于若接收到用于访问第一接口的第一接口文档的请求，则获取所述第一接口对应的第一接口数据，所述第一接口数据根据已注解的第一接口程序生成。
解析单元用于对所述第一接口数据进行解析，得到所述第一接口的属性信息。
文档生成单元用于将所述第一接口的属性信息对应添加至预设的接口文档模板中，得到所述第一接口文档，并显示所述第一接口文档。
接口程序获取单元用于获取第一接口对应的已注解的第一接口程序。
接口数据生成单元用于根据所述已注解的第一接口程序以及预设的接口数据生成策略，生成与所述第一接口对应的第一接口数据。
第二获取单元用于若接收到用于调用第一接口的接口调用请求，则获取所述第一接口的待校验参数对应的校验策略。
参数校验单元用于根据所述待校验参数对应的校验策略，对所述接口调用请求携带的所述待校验参数的参数值进行校验。
进一步的，第二获取单元可以被分割成第一确定单元和校验策略获取单元。
第一确定单元用于若接收到用于调用第一接口的接口调用请求，则根据已注解的第一接口程序，确定所述第一接口的待校验参数。第一确定单元将第一接口的待校验参数发送至校验策略获取单元。
校验策略获取单元用于接收第一确定单元发送的第一接口的待校验参数，获取所述待校验参数对应的校验策略。
进一步的，检验策略获取单元具体用于：根据所述已注解的第一接口程序，确定所述待校验参数对应的注解类型；根据注解类型与检验策略之间的预设对应关系，确定所述待校验参数对应的校验策略。
所述生成接口文档的装置可以是桌上型计算机、笔记本、掌上电脑及云端服务器等计算设备。所述生成接口文档的装置可包括，但不仅限于，处理器501、存储器502。本领域技术人员可以理解，图5仅仅是生成接口文档的装置500的示例，并不构成对生成接口文档的装置500的限定，可以包括比图示更多或更少的部件，或者组合某些部件，或者不同的部件，例如所述调节封闭工作环境的装置还可以包括输入输出设备、网络接入设备、总线等。
所称处理器501可以是中央处理单元(Central Processing Unit，CPU)，还可以是其他通用处理器、数字信号处理器(Digital Signal Processor，DSP)、专用集成电路(Application Specific Integrated Circuit，ASIC)、现成可编程门阵列(Field-Programmable Gate Array，FPGA)或者其他可编程逻辑器件、分立门或者晶体管逻辑器件、分立硬件组件等。通用处理器可以是微处理器或者该处理器也可以是任何常规的处理器等。
所述存储器502可以是所述生成接口文档的装置500的内部存储单元，例如生成接口文档的装置500的硬盘或内存。所述存储器502也可以是所述生成接口文档的装置500的外部存储设备，例如所述生成接口文档的装置500上配备的插接式硬盘，智能存储卡(SmartMedia Card,SMC)，安全数字(Secure Digital,SD)卡，闪存卡(Flash Card)等。进一步地，所述存储器502还可以既包括所述生成接口文档的装置500的内部存储单元也包括外部存储设备。所述存储器502用于存储所述计算机程序以及所述调节封闭工作环境的装置所需的其他程序和数据。所述存储器502还可以用于暂时地存储已经输出或者将要输出的数据。
所属领域的技术人员可以清楚地了解到，为了描述的方便和简洁，仅以上述各功能单元、模块的划分进行举例说明，实际应用中，可以根据需要而将上述功能分配由不同的功能单元、模块完成，即将所述装置的内部结构划分成不同的功能单元或模块，以完成以上描述的全部或者部分功能。实施例中的各功能单元、模块可以集成在一个处理单元中，也可以是各个单元单独物理存在，也可以两个或两个以上单元集成在一个单元中，上述集成的单元既可以采用硬件的形式实现，也可以采用软件功能单元的形式实现。另外，各功能单元、模块的具体名称也只是为了便于相互区分，并不用于限制本申请的保护范围。上述设备中单元、模块的具体工作过程，可以参考前述方法实施例中的对应过程，在此不再赘述。
在上述实施例中，对各个实施例的描述都各有侧重，某个实施例中没有详述或记载的部分，可以参见其它实施例的相关描述。
本领域普通技术人员可以意识到，结合本文中所公开的实施例描述的各示例的单元及算法步骤，能够以电子硬件、或者计算机软件和电子硬件的结合来实现。这些功能究竟以硬件还是软件方式来执行，取决于技术方案的特定应用和设计约束条件。专业技术人员可以对每个特定的应用来使用不同方法来实现所描述的功能，但是这种实现不应认为超出本发明的范围。
在本发明所提供的实施例中，应该理解到，所揭露的装置/终端设备和方法，可以通过其它的方式实现。例如，以上所描述的装置/终端设备实施例仅仅是示意性的，例如，所述模块或单元的划分，仅仅为一种逻辑功能划分，实际实现时可以有另外的划分方式，例如多个单元或组件可以结合或者可以集成到另一个设备，或一些特征可以忽略，或不执行。另一点，所显示或讨论的相互之间的耦合或直接耦合或通讯连接可以是通过一些接口，装置或单元的间接耦合或通讯连接，可以是电性，机械或其它的形式。
所述作为分离部件说明的单元可以是或者也可以不是物理上分开的，作为单元显示的部件可以是或者也可以不是物理单元，即可以位于一个地方，或者也可以分布到多个网络单元上。可以根据实际的需要选择其中的部分或者全部单元来实现本实施例方案的目的。
另外，在本发明各个实施例中的各功能单元可以集成在一个处理单元中，也可以是各个单元单独物理存在，也可以两个或两个以上单元集成在一个单元中。上述集成的单元既可以采用硬件的形式实现，也可以采用软件功能单元的形式实现。
所述集成的模块/单元如果以软件功能单元的形式实现并作为独立的产品销售或使用时，可以存储在一个计算机可读取存储介质中。基于这样的理解，本发明实现上述实施例方法中的全部或部分流程，也可以通过计算机程序来指令相关的硬件来完成，所述的计算机程序可存储于一计算机可读存储介质中，该计算机程序在被处理器执行时，可实现上述各个方法实施例的步骤。其中，所述计算机程序包括计算机程序代码，所述计算机程序代码可以为源代码形式、对象代码形式、可执行文件或某些中间形式等。所述计算机可读介质可以包括：能够携带所述计算机程序代码的任何实体或装置、记录介质、U盘、移动硬盘、磁碟、光盘、计算机存储器、只读存储器(ROM，Read-Only Memory)、随机存取存储器(RAM，Random Access Memory)、电载波信号、电信信号以及软件分发介质等。需要说明的是，所述计算机可读介质包含的内容可以根据司法管辖区内立法和专利实践的要求进行适当的增减，例如在某些司法管辖区，根据立法和专利实践，计算机可读介质不包括电载波信号和电信信号。
以上所述实施例仅用以说明本发明的技术方案，而非对其限制；尽管参照前述实施例对本发明进行了详细的说明，本领域的普通技术人员应当理解：其依然可以对前述各实施例所记载的技术方案进行修改，或者对其中部分技术特征进行等同替换；而这些修改或者替换，并不使相应技术方案的本质脱离本发明各实施例技术方案的精神和范围，均应包含在本发明的保护范围之内。
Claims (10)
1.一种生成接口文档的方法，其特征在于，包括：
若接收到用于访问第一接口的第一接口文档的请求，则获取所述第一接口对应的第一接口数据，所述第一接口数据根据已注解的第一接口程序生成；
对所述第一接口数据进行解析，得到所述第一接口的属性信息；
将所述第一接口的属性信息对应添加至预设的接口文档模板中，得到所述第一接口文档，并显示所述第一接口文档。
2.根据权利要求1所述的方法，其特征在于，所述若接收到用于访问第一接口的第一接口文档的请求，则获取所述第一接口对应的第一接口数据，所述第一接口数据根据已注解的第一接口程序生成之前，包括：
获取第一接口对应的已注解的第一接口程序；
根据所述已注解的第一接口程序以及预设的接口数据生成策略，生成与所述第一接口对应的第一接口数据。
3.根据权利要求1所述的方法，其特征在于，还包括：
若接收到用于调用第一接口的接口调用请求，则获取所述第一接口的待校验参数对应的校验策略；
根据所述待校验参数对应的校验策略，对所述接口调用请求携带的所述待校验参数的参数值进行校验。
4.根据权利要求3所述的方法，其特征在于，所述若接收到用于调用第一接口的接口调用请求，则获取所述第一接口的待校验参数对应的校验策略，包括：
若接收到用于调用第一接口的接口调用请求，则根据已注解的第一接口程序，确定所述第一接口的待校验参数；
获取所述待校验参数对应的校验策略。
5.根据权利要求4所述的方法，其特征在于，所述获取所述待校验参数对应的校验策略，包括：
根据所述已注解的第一接口程序，确定所述待校验参数对应的注解类型；
根据注解类型与检验策略之间的预设对应关系，确定所述待校验参数对应的校验策略。
6.一种生成接口文档的装置，其特征在于，包括：
第一获取单元，用于若接收到用于访问第一接口的第一接口文档的请求，则获取所述第一接口对应的第一接口数据，所述第一接口数据根据已注解的第一接口程序生成；
解析单元，用于对所述第一接口数据进行解析，得到所述第一接口的属性信息；
文档生成单元，用于将所述第一接口的属性信息对应添加至预设的接口文档模板中，得到所述第一接口文档，并显示所述第一接口文档。
7.根据权利要求6所述的装置，其特征在于，还包括：
接口程序获取单元，用于获取第一接口对应的已注解的第一接口程序；
接口数据生成单元，用于根据所述已注解的第一接口程序以及预设的接口数据生成策略，生成与所述第一接口对应的第一接口数据。
8.根据权利要求6所述的装置，其特征在于，还包括：
第二获取单元，用于若接收到用于调用第一接口的接口调用请求，则获取所述第一接口的待校验参数对应的校验策略；
参数校验单元，用于根据所述待校验参数对应的校验策略，对所述接口调用请求携带的所述待校验参数的参数值进行校验。
9.一种生成接口文档的装置，包括存储器、处理器以及存储在所述存储器中并可在所述处理器上运行的计算机程序，其特征在于，所述处理器执行所述计算机程序时实现如权利要求1至5任一项所述方法的步骤。
10.一种计算机可读存储介质，所述计算机可读存储介质存储有计算机程序，其特征在于，所述计算机程序被处理器执行时实现如权利要求1至5任一项所述方法的步骤。
Priority Applications (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN201710846088.2A CN107766040A (zh) | 2017-09-19 | 2017-09-19 | 一种生成接口文档的方法、装置及计算机可读存储介质 |
Applications Claiming Priority (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN201710846088.2A CN107766040A (zh) | 2017-09-19 | 2017-09-19 | 一种生成接口文档的方法、装置及计算机可读存储介质 |
Publications (1)
| Publication Number | Publication Date |
|---|---|
| CN107766040A true CN107766040A (zh) | 2018-03-06 |
Family
ID=61265519
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| CN201710846088.2A Pending CN107766040A (zh) | 2017-09-19 | 2017-09-19 | 一种生成接口文档的方法、装置及计算机可读存储介质 |
Country Status (1)
| Country | Link |
|---|---|
| CN (1) | CN107766040A (zh) |
Cited By (16)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN108804103A (zh) * | 2018-06-20 | 2018-11-13 | 郑州云海信息技术有限公司 | 一种扫描接口并生成可调用api接口文档的方法 |
| CN109408375A (zh) * | 2018-09-27 | 2019-03-01 | 深圳壹账通智能科技有限公司 | 接口文档的生成方法和装置 |
| CN110244952A (zh) * | 2019-05-09 | 2019-09-17 | 恩亿科(北京)数据科技有限公司 | 应用程序编程接口文档的管理方法和计算机可读存储介质 |
| CN110377336A (zh) * | 2019-06-17 | 2019-10-25 | 平安普惠企业管理有限公司 | 接口文档生成方法、装置、计算机设备和存储介质 |
| CN110647350A (zh) * | 2019-08-30 | 2020-01-03 | 深圳壹账通智能科技有限公司 | 接口文档生成方法、装置、计算机设备和存储介质 |
| CN110704102A (zh) * | 2019-09-12 | 2020-01-17 | 北京字节跳动网络技术有限公司 | 页面跳转协议接口文档生成方法、系统、介质和电子设备 |
| CN110806863A (zh) * | 2019-11-05 | 2020-02-18 | 泰康保险集团股份有限公司 | 接口文档生成方法及装置、电子设备、存储介质 |
| CN111367685A (zh) * | 2020-02-28 | 2020-07-03 | 平安医疗健康管理股份有限公司 | 接口调用的方法及装置、计算机设备、存储介质 |
| CN111880778A (zh) * | 2020-06-30 | 2020-11-03 | 百度在线网络技术（北京）有限公司 | 接口文档的生成方法、装置、电子设备及存储介质 |
| CN112148356A (zh) * | 2019-06-28 | 2020-12-29 | 腾讯科技（深圳）有限公司 | 文档生成方法、接口开发方法、装置、服务器及存储介质 |
| CN112287009A (zh) * | 2020-11-03 | 2021-01-29 | 平安普惠企业管理有限公司 | 接口调用和接口数据入库方法、装置、设备及存储介质 |
| CN112579055A (zh) * | 2020-12-11 | 2021-03-30 | 平安普惠企业管理有限公司 | 接口参数校验方法、装置及计算机可读存储介质 |
| CN112783551A (zh) * | 2021-01-21 | 2021-05-11 | 中信银行股份有限公司 | 微服务框架的接口文档生成方法、电子设备及存储介质 |
| CN113157792A (zh) * | 2021-05-10 | 2021-07-23 | 中国工商银行股份有限公司 | 一种接口文档管理系统及其工作方法 |
| CN113626074A (zh) * | 2021-06-30 | 2021-11-09 | 北京三快在线科技有限公司 | 接口文档生成方法及装置、电子设备及可读存储介质 |
| CN113741893A (zh) * | 2021-08-02 | 2021-12-03 | 重庆长安汽车股份有限公司 | 一种基于json解析的开放平台接口文档自动生成方法及系统 |
Citations (4)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| US20110202933A1 (en) * | 2010-02-17 | 2011-08-18 | Justin Lee Sherrill | Automatically generating documentation on application programming interfaces |
| CN103473045A (zh) * | 2013-08-27 | 2013-12-25 | 广州华多网络科技有限公司 | 一种生成接口文档的方法及装置 |
| CN104375814A (zh) * | 2013-08-14 | 2015-02-25 | 腾讯科技（深圳）有限公司 | 接口文档的生成方法及装置 |
| CN105677326A (zh) * | 2015-12-28 | 2016-06-15 | 国云科技股份有限公司 | 一种软件接口参数验证方法 |
-
2017
- 2017-09-19 CN CN201710846088.2A patent/CN107766040A/zh active Pending
Patent Citations (4)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| US20110202933A1 (en) * | 2010-02-17 | 2011-08-18 | Justin Lee Sherrill | Automatically generating documentation on application programming interfaces |
| CN104375814A (zh) * | 2013-08-14 | 2015-02-25 | 腾讯科技（深圳）有限公司 | 接口文档的生成方法及装置 |
| CN103473045A (zh) * | 2013-08-27 | 2013-12-25 | 广州华多网络科技有限公司 | 一种生成接口文档的方法及装置 |
| CN105677326A (zh) * | 2015-12-28 | 2016-06-15 | 国云科技股份有限公司 | 一种软件接口参数验证方法 |
Cited By (21)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN108804103A (zh) * | 2018-06-20 | 2018-11-13 | 郑州云海信息技术有限公司 | 一种扫描接口并生成可调用api接口文档的方法 |
| CN109408375A (zh) * | 2018-09-27 | 2019-03-01 | 深圳壹账通智能科技有限公司 | 接口文档的生成方法和装置 |
| CN109408375B (zh) * | 2018-09-27 | 2023-06-09 | 深圳壹账通智能科技有限公司 | 接口文档的生成方法和装置 |
| CN110244952A (zh) * | 2019-05-09 | 2019-09-17 | 恩亿科(北京)数据科技有限公司 | 应用程序编程接口文档的管理方法和计算机可读存储介质 |
| CN110377336A (zh) * | 2019-06-17 | 2019-10-25 | 平安普惠企业管理有限公司 | 接口文档生成方法、装置、计算机设备和存储介质 |
| CN112148356A (zh) * | 2019-06-28 | 2020-12-29 | 腾讯科技（深圳）有限公司 | 文档生成方法、接口开发方法、装置、服务器及存储介质 |
| CN112148356B (zh) * | 2019-06-28 | 2024-03-22 | 腾讯科技（深圳）有限公司 | 文档生成方法、接口开发方法、装置、服务器及存储介质 |
| CN110647350A (zh) * | 2019-08-30 | 2020-01-03 | 深圳壹账通智能科技有限公司 | 接口文档生成方法、装置、计算机设备和存储介质 |
| CN110704102A (zh) * | 2019-09-12 | 2020-01-17 | 北京字节跳动网络技术有限公司 | 页面跳转协议接口文档生成方法、系统、介质和电子设备 |
| CN110806863A (zh) * | 2019-11-05 | 2020-02-18 | 泰康保险集团股份有限公司 | 接口文档生成方法及装置、电子设备、存储介质 |
| CN111367685A (zh) * | 2020-02-28 | 2020-07-03 | 平安医疗健康管理股份有限公司 | 接口调用的方法及装置、计算机设备、存储介质 |
| CN111367685B (zh) * | 2020-02-28 | 2022-11-15 | 深圳平安医疗健康科技服务有限公司 | 接口调用的方法及装置、计算机设备、存储介质 |
| CN111880778A (zh) * | 2020-06-30 | 2020-11-03 | 百度在线网络技术（北京）有限公司 | 接口文档的生成方法、装置、电子设备及存储介质 |
| CN111880778B (zh) * | 2020-06-30 | 2023-12-22 | 百度在线网络技术（北京）有限公司 | 接口文档的生成方法、装置、电子设备及存储介质 |
| CN112287009A (zh) * | 2020-11-03 | 2021-01-29 | 平安普惠企业管理有限公司 | 接口调用和接口数据入库方法、装置、设备及存储介质 |
| CN112579055A (zh) * | 2020-12-11 | 2021-03-30 | 平安普惠企业管理有限公司 | 接口参数校验方法、装置及计算机可读存储介质 |
| CN112783551A (zh) * | 2021-01-21 | 2021-05-11 | 中信银行股份有限公司 | 微服务框架的接口文档生成方法、电子设备及存储介质 |
| CN113157792A (zh) * | 2021-05-10 | 2021-07-23 | 中国工商银行股份有限公司 | 一种接口文档管理系统及其工作方法 |
| CN113157792B (zh) * | 2021-05-10 | 2024-04-30 | 中国工商银行股份有限公司 | 一种接口文档管理系统及其工作方法 |
| CN113626074A (zh) * | 2021-06-30 | 2021-11-09 | 北京三快在线科技有限公司 | 接口文档生成方法及装置、电子设备及可读存储介质 |
| CN113741893A (zh) * | 2021-08-02 | 2021-12-03 | 重庆长安汽车股份有限公司 | 一种基于json解析的开放平台接口文档自动生成方法及系统 |
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| CN107766040A (zh) | 一种生成接口文档的方法、装置及计算机可读存储介质 | |
| CN108268253B (zh) | 接口代码生成方法及终端设备 | |
| CN108427644A (zh) | 服务测试方法、服务测试系统及服务测试装置 | |
| CN108415832A (zh) | 接口自动化测试方法、装置、设备及存储介质 | |
| CN109815657A (zh) | 一种基于联盟链的身份认证方法及终端设备 | |
| CN110442524A (zh) | 一种针对带有认证授权的web服务接口测试方法和装置 | |
| CN107908566A (zh) | 自动化测试管理方法、装置、终端设备及存储介质 | |
| CN110221968A (zh) | 软件测试方法及相关产品 | |
| CN107741904A (zh) | 测试机自动配置方法、装置、设备及存储介质 | |
| US8839197B2 (en) | Automated analysis of composite applications | |
| CN108958992A (zh) | 测试方法和装置 | |
| CN109460223A (zh) | 一种api网关管理系统及其方法 | |
| CN108255714A (zh) | 接口文档构建测试方法及终端设备 | |
| CN107885658B (zh) | 测试前置实现方法、装置、终端设备及存储介质 | |
| CN107870989A (zh) | 网页生成方法及终端设备 | |
| CN110162464A (zh) | Mcok测试方法及系统、电子设备及可读存储介质 | |
| CN107358439A (zh) | 应用支付方法、装置及终端设备 | |
| CN108255707A (zh) | 测试用例的开发角色创建方法、装置、设备及存储介质 | |
| CN110109831A (zh) | 自动化测试框架系统、自动化测试方法及终端设备 | |
| CN107862352A (zh) | 一种二维码分享方法及二维码分享设备 | |
| CN105786695A (zh) | 数据测试方法及系统 | |
| CN110134596A (zh) | 测试文档的生成方法及终端设备 | |
| CN110309099A (zh) | 接口管理方法、装置、设备及计算机可读存储介质 | |
| CN107273300A (zh) | 一种应用程序测试方法和装置 | |
| CN107341235A (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 | ||
| CB02 | Change of applicant information | ||
| CB02 | Change of applicant information |
Address after: 518000 Room 201, A building, No. 1, Qian Wan Road, Qianhai Shenzhen Hong Kong cooperation zone, Shenzhen, Guangdong (Shenzhen Qianhai business secretary Co., Ltd.):No. 1701, 1702B, A, New Hao one town, No. 7018 Cai Tian Road, Futian, Shenzhen Applicant after: Maimaiti Mdt InfoTech Ltd, Shenzhen Address before: 518000 Room 201, building A, 1 front Bay Road, Shenzhen Qianhai cooperation zone, Shenzhen, Guangdong Applicant before: Shenzhen Maimaiti Tesco Nationwide Financial Services Inc |
|
| CB02 | Change of applicant information | ||
| CB02 | Change of applicant information |
Address after: Room 201, Building A, No. 1 Qianwan Road, Qianhai Shenzhen-Hong Kong Cooperation Zone, Shenzhen, Guangdong 518000:No. 1701, 1702B, A, New Hao one town, No. 7018 Cai Tian Road, Futian, Shenzhen 518000 Room 201, No. 1 A (Qianhai business secretary, Shenzhen, Shenzhen City, Qianhai Shenzhen Hong Kong cooperation zone, Shenzhen City, Guangdong) Applicant after: Shenzhen Rongyimai Information Technology Co., Ltd. Address before: Room 201, Building A, No. 1 Qianwan Road, Qianhai Shenzhen-Hong Kong Cooperation Zone, Shenzhen, Guangdong 518000:No. 1701, 1702B, A, New Hao one town, No. 7018 Cai Tian Road, Futian, Shenzhen 518000 Room 201, No. 1 A (Qianhai business secretary, Shenzhen, Shenzhen City, Qianhai Shenzhen Hong Kong cooperation zone, Shenzhen City, Guangdong) Applicant before: Maimaiti Mdt InfoTech Ltd, Shenzhen |
|
| RJ01 | Rejection of invention patent application after publication | ||
| RJ01 | Rejection of invention patent application after publication |
Application publication date: 20180306 |