CN114201215A - 接口文档的生成方法、装置、电子设备及存储介质 - Google Patents
接口文档的生成方法、装置、电子设备及存储介质 Download PDFInfo
- Publication number
- CN114201215A CN114201215A CN202111416733.XA CN202111416733A CN114201215A CN 114201215 A CN114201215 A CN 114201215A CN 202111416733 A CN202111416733 A CN 202111416733A CN 114201215 A CN114201215 A CN 114201215A
- Authority
- CN
- China
- Prior art keywords
- interface
- interface document
- document
- code
- storage medium
- 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
Images
Classifications
-
- 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
-
- 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/36—Software reuse
Landscapes
- Engineering & Computer Science (AREA)
- Software Systems (AREA)
- General Engineering & Computer Science (AREA)
- Theoretical Computer Science (AREA)
- Physics & Mathematics (AREA)
- General Physics & Mathematics (AREA)
- Library & Information Science (AREA)
- Document Processing Apparatus (AREA)
Abstract
本发明实施例涉及一种接口文档的生成方法、装置、电子设备及存储介质,包括:加载接口文档生成工具;获取目标接口的接口代码以及所述接口代码的代码注释;将所述接口代码以及所述代码注释输入至所述接口文档生成工具,得到所述目标接口的接口文档。由此,可以实现通过接口文档生成工具自动生成接口文档,减少工作量,加快工作效率。
Description
技术领域
本发明实施例涉及计算机应用技术领域,尤其涉及一种接口文档的生成方法、装置、电子设备及存储介质。
背景技术
以接口的方式提供的开放能力,需要提供接口文档给到需要使用这些接口的企业或者开发商,除了一些标准接口外,还有很多是定制接口,经常需要更改接口的参数。
现有技术中,新开发接口都需要手写接口文档,导致工作量很大,并且当需求发生变更时,需要修改接口字段,因此接口和文档不容易保持一致。
发明内容
鉴于此,为解决上述开发接口需要手写接口文档,导致工作量很大,以及在修改接口字段时,导致接口和文档不一致的技术问题,本发明实施例提供一种接口文档的生成方法、装置、电子设备及存储介质。
第一方面,本发明实施例提供一种接口文档的生成方法,包括:
加载接口文档生成工具;
获取目标接口的接口代码以及所述接口代码的代码注释;
将所述接口代码以及所述代码注释输入至所述接口文档生成工具,得到所述目标接口的接口文档。
在一可能的实施方式中,所述方法还包括:
将所述接口文档存储至指定存储介质,并生成所述接口文档在所述指定存储介质中的存储地址。
在一可能的实施方式中,在所述将所述接口文档存储至指定存储介质,并生成所述接口文档在所述指定存储介质中的存储地址之后,所述方法还包括:
当接收到接口文档下载指令时,根据所述存储地址从所述指定存储介质中下载所述接口文档;
对下载的接口文档进行格式转换,得到JSON格式的接口文档;
通过浏览器输出所述JSON格式的接口文档。
在一可能的实施方式中,所述方法还包括:
在检测到所述目标接口的接口代码发生更新时,将更新后的接口代码以及所述更新后的接口代码的代码注释重新输入至所述接口文档生成工具,得到更新后的所述目标接口的接口文档。
在一可能的实施方式中,在所述得到更新后的所述目标接口的接口文档之后,所述方法还包括:
将更新后的所述目标接口的接口文档上传至所述指定存储介质,以更新所述指定存储介质中的所述目标接口的接口文档,以及重新生成所述更新后的接口文档在所述指定存储介质中的存储地址。
第二方面,本发明实施例提供一种接口文档的生成装置,包括:
加载模块,用于加载接口文档生成工具;
获取模块,用于获取目标接口的接口代码以及所述接口代码的代码注释;
确定模块,用于将所述接口代码以及所述代码注释输入至所述接口文档生成工具,得到所述目标接口的接口文档。
在一可能的实施方式中,所述装置还包括:
存储模块,用于将所述接口文档存储至指定存储介质,并生成所述接口文档在所述指定存储介质中的存储地址。
在一可能的实施方式中,所述装置还包括:
下载模块,用于在所述将所述接口文档上传存储至指定存储介质,并生成面向所述指定存储介质的接口文档的文档地址之后,执行当接收到接口文档下载指令时,根据所述存储地址从所述指定存储介质中下载所述接口文档;
转换模块,用于对下载的接口文档进行格式转换,得到JSON格式的接口文档;
输出模块,用于通过浏览器输出所述JSON格式的接口文档。
在一可能的实施方式中,所述装置还包括:
文档确定模块,用于在检测到所述目标接口的接口代码发生更新时,将更新后的接口代码以及所述更新后的接口代码的代码注释重新输入至所述接口文档生成工具,得到更新后的所述目标接口的接口文档。
在一可能的实施方式中,所述装置还包括:
文档存储模块,用于在所述得到更新后的所述目标接口的接口文档之后,执行将更新后的所述目标接口的接口文档上传至所述指定存储介质,以更新所述指定存储介质中的所述目标接口的接口文档,以及重新生成所述更新后的接口文档在所述指定存储介质中的存储地址。
第三方面,本发明实施例提供一种电子设备,包括:处理器和存储器,所述处理器用于执行所述存储器中存储的接口文档的生成程序,以实现第一方面中任一项所述的接口文档的生成方法。
第四方面,本发明实施例提供一种存储介质,所述存储介质存储有一个或者多个程序,所述一个或者多个程序可被一个或者多个处理器执行,以实现第一方面中任一项所述的接口文档的生成方法。
本发明实施例提供的技术方案,通过加载接口文档生成工具,再获取到目标接口的接口代码以及接口代码的代码注释,并将该接口代码以及代码注释输入至接口文档生成工具,得到目标接口的接口文档,可以实现自动生成接口文档,减少写文档的工作量,避免了每次新开发接口需要手写接口文档,加快了工作效率,提升用户体验感。
附图说明
图1为本发明实施例提供的一种接口文档的生成方法的实施例流程图;
图2为本发明实施例提供的另一种接口文档的生成方法的实施例流程图;
图3为本发明实施例提供的又一种接口文档的生成方法的实施例流程图;
图4为本发明实施例提供的通过浏览器输出的接口文档的部分页面示意图;
图5为本发明实施例提供的一种接口文档的生成装置的实施例框图;
图6为本发明实施例提供的一种电子设备的结构示意图。
具体实施方式
为使本发明实施例的目的、技术方案和优点更加清楚,下面将结合本发明实施例中的附图,对本发明实施例中的技术方案进行清楚、完整地描述,显然,所描述的实施例是本发明一部分实施例,而不是全部的实施例。基于本发明中的实施例,本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例,都属于本发明保护的范围。
为便于理解,下面结合附图以具体实施例对本发明提供的接口文档的生成方法做进一步的解释说明,实施例并不构成对本发明实施例的限定。
参见图1,为本发明实施例提供的一种接口文档的生成方法的实施例流程图。在一个例子中,该方法可适用于JAVA语言,可应用于电子设备上,例如平板电脑、台式计算机等,本发明实施例对此不做限制。如图1所示,该流程可包括以下步骤:
S101.加载接口文档生成工具。
在一实施例中,定义文档生成规则,即定义编写代码注释规范,包括定义接口注释的规范和定义参数注释的规范。举例来说,定义接口注释的规范示例:
根据上述设定的文档生成规则,可以使用功能组件加载接口文档生成工具,其中,该功能组件可以是QDox代码分析器,该QDox代码分析器是一种高速,小型代码分析器,用于从Java源文件提取类/接口/方法的文档@标签。它是设计用来作为一个代码生成器和文档的工具。
通过这种处理,可以实现通过接口文档生成工具自动生成接口文档。
S102.获取目标接口的接口代码以及接口代码的代码注释。
在一实施例中,用户可以根据定义的规则,编写目标接口的接口代码以及接口代码的代码注释,设备可以接收到用户输入的目标接口的接口代码以及接口代码的代码注释,其中,上述定义的规则与S101中设定的代码规范相对应,也即用户编写的接口代码中属性值来自设定的代码规范的内容。
通过这种处理,可以实现目标接口的接口代码是根据设定的代码规范的内容进行编写的,保证了代码的统一性,避免了根据不同标准而编写的代码执行进一步规范的操作,加快了工作效率,节省了工作时间。
S103.将接口代码以及代码注释输入至接口文档生成工具,得到目标接口的接口文档。
由上述描述可见,在一实施例中,根据设定的规则使用功能组件读取接口代码以及代码注释,并将其输入至接口文档生成工具,这里,该接口文档生成工具可以是使用功能组件开发的一个工具类,通过该工具类可以读取接口代码以及代码注释,进而生成目标接口的接口文档,其中,该功能组件可以是QDox代码分析器,这里,QDox是源码解析工具,它能获取源码的所有信息,类信息、方法名、参数名、注释等都可获取,如要生成中文接口文档,必须要由使用者先对接口和参数进行注释,可根据自己定义的规则进行注释,如不需要中文文档,不用注释也可生成,即只读取代码而生成,可读性会比较差,举例说明,假如有这样一个接口:
get(VO vo)
VO参数字段为:
private String userId;
如果不写注释生成的文档大概如下:
接口地址:/get
参数名|参数类型
userId|String
如果写如下注释:
这时生成的接口文档大概如下:
获取账号信息接口
接口地址:/user/get
参数名|参数类型|是否必须|说明|示例值
UserId|String|是|用户ID|1012。
将读取到的接口代码以及代码注释输入至接口文档生成工具,通过该工具类读取接口代码以及代码注释,进而生成目标接口的接口文档,这里,生成的目标接口的接口文档可以是可扩展标记语言XML格式文档,还可以是其他格式文档,例如JSON,MD,WORD等,对此不做任何限制,这里可以以生成XML格式文档为例,原因是,XML文档格式统一,符合标准,举例来说:XML格式的接口文档如下:
<?xml version="1.0"encoding="UTF-8"standalone="yes"?>
<document>
<basicInfo name="删除素材标签接口"description="删除素材标签"url="/common/api/v2/materialTag/deleteTag"domain="https://xxx.3vjia.com"method="POST,application/json"resultType="JSON"remark="access_token=xxx中,xxx是从xxx.3vjia.com获取到的token"/>
<params>
<field name="tagId"description="标签ID"type="String"example="123456"must="是"defaultValue=""/>
</params>
<paramsExample url="{{paramsExampleUrl}}"/>
<returns>
<field name="success"description="请求是否成功"type="Boolean"example="true"must="是"defaultValue=""/>
<field name="errorCode"description="错误码,success=false时可能有值,详见错误码说明表格"type="Integer"example="500001"must="否"defaultValue=""/>
<field name="errorMessage"description="错误信息,success=false时有值"type="String"example="用户不存在"must="否"defaultValue=""/>
<field name="result"description="删除是否成功,一般为true,失败会以success=false的形式返回"type="Boolean"example="true"must="否"defaultValue=""/>
</returns>
<returnExample url="{{returnExampleUrl}}"/>
<errorCodes>
<errorCodes value="500000"description="系统异常,原因:xxx"/>
<errorCodes value="-3"description="传入的参数不符合要求"/>
<errorCodes value="611006"description="删除标签失败,原因:xxx"/>
</errorCodes>
<codeExample/>
<annexs/>
</document>
其中,paramsExampleUrl和returnExampleUrl是具体的JSON链接,具体是:
paramsExampleUrl:
{tagId:"123456"}
returnExampleUrl:
{result:true,
success:true}
通过图1所示流程可以看出,在本发明的技术方案中,通过加载接口文档生成工具,再获取到目标接口的接口代码以及接口代码的代码注释,并将该接口代码以及代码注释输入至接口文档生成工具,得到目标接口的接口文档,可以实现自动生成接口文档,减少写文档的工作量,避免了每次新开发接口需要手写接口文档,加快了工作效率,提升用户体验感。
参见图2,为本发明实施例提供的另一种接口文档的生成方法的实施例流程图。如图2所示,该流程可包括以下步骤:
S201.加载接口文档生成工具。
S202.获取目标接口的接口代码以及接口代码的代码注释。
S203.将接口代码以及代码注释输入至接口文档生成工具,得到目标接口的接口文档。
S201~S203在图1的S101~S103中已做详细介绍,这里不再赘述。
S204.将接口文档存储至指定存储介质,并生成接口文档在指定存储介质中的存储地址。
上述指定存储介质可以是文件服务器,还可以是文件数据库,例如,百度网盘、阿里云对象存储(Object Storage Service,OSS)等,其中,阿里云对象存储OSS是一款海量、安全、低成本、高可靠的云存储服务,本发明实施例对此不做任何限制。
上述存储地址包括接口文档地址和在线接口地址,其中,接口文档地址是接口文档的地址,在线接口地址是可以直接访问的接口地址,例如,https://dev.3vjia.com/document?target=MaterialTagService-deleteTag-1603796683200,其中target指定了具体的接口文档地址。
由S204的描述可见,将接口文档存储至指定存储介质,生成接口文档在指定存储介质中的存储地址,举例来说,将接口文档上传到百度网盘,可以获得该接口文档在百度网盘中的存储地址。
通过这种处理方式,可以时间将接口文档上传到指定的接口文档进行保存,避免接口文档的丢失,同时生成了该接口文档在指定存储介质中的存储地址,便于用户或者其他人下载使用。
S205.当接收到接口文档下载指令时,根据存储地址从指定存储介质中下载接口文档。
由S205的描述可见,在接收到对接口文档的下载指令时,根据上述生成的接口文档在指定存储介质中的存储地址,可以从指定存储介质中下载该接口文档。
通过这种处理方式,可以实现在使用接口文档时,即可在指定存储介质中下载,节省了工作时间,加快了工作效率。
S206.对下载的接口文档进行格式转换,得到JSON格式的接口文档。
由S206的描述可见,将从指定存储介质中下载的接口文档进行格式转换,可以得到JSON格式的接口文档,其中,JSON数据格式简单,格式是压缩的,方便数据传输和交互。
在一实施例中,接口文档以XML格式文档为例,加载可以解析XML格式文档的方法,生成可以在浏览器中展示的JSON数据,其中,解析XML格式文档的方法是指每种开发语言都有这样的基础工具包,使用里面的工具类即可读取解析XML文档,并且这里只解析XML格式,举例来说,
需要说明的是,对接口文档进行解析,也可以生成其他格式的数据,只要前端使用对应格式的解析即可,这里仅以生成JSON格式数据为例。
S207.通过浏览器输出JSON格式的接口文档。
在一实施例中,可以通过指定功能组件对JSON格式数据进行编译,将最终的JSON格式的接口文档通过浏览器展示给用户,例如,https://dev.3vjia.com/document?target=MaterialTagService-deleteTag-1603796683200,参见图4,为本发明实施例提供的通过浏览器输出的接口文档的部分页面示意图。
上述指定功能组件可以是Marked编译器,该Marked是一个JavaScript编写的全功能Markdown解析和编译器,对JSON格式的数据进行编译的目的是为了展示,使用Marked是为了能展示JSON里面的MD格式的内容,为了美化展示的样式,不使用也可以。
至此,完成图2所示流程的相关描述。
在本发明技术方案中,首先通过加载接口文档生成工具,将获取到的目标接口的接口代码以及接口代码的代码注释输入至接口文档生成工具,由此可以得到目标接口的接口文档,将该接口文档上传至指定存储介质的,并获得该接口文档的存储地址,在接收到接口文档的下载指令时,可以根据该存储地址从指定存储介质中下载接口文档,并对该接口文档进行格式转换,得到JSON格式的接口文档,并通过浏览器输出JSON格式的接口文档,可以实现接口文档的自动生成以及对接口文档的存储和下载,通过对接口文档进行格式转换,可以实现在浏览器中展示JSON格式的接口文档,便于用户查看,提升用户体验感。
参见图3,为本发明实施例提供的又一种接口文档的生成方法的实施例流程图。如图3所示,该流程可包括以下步骤:
S301.加载接口文档生成工具。
S302.获取目标接口的接口代码以及接口代码的代码注释。
S303.将接口代码以及代码注释输入至接口文档生成工具,得到目标接口的接口文档。
S301~S303在图1的S101~S103中已做详细介绍,这里不再赘述。
S304.将接口文档存储至指定存储介质,并生成接口文档在指定存储介质中的存储地址。
S305.在检测到目标接口的接口代码发生更新时,将更新后的接口代码以及更新后的接口代码的代码注释重新输入至接口文档生成工具,得到更新后的目标接口的接口文档。
S306.将更新后的目标接口的接口文档上传至指定存储介质,以更新指定存储介质中的目标接口的接口文档,以及重新生成更新后的接口文档在指定存储介质中的存储地址。
以下对S304~S306进行统一描述,其中,S304在图2的S204中已做详细介绍,这里不再赘述:
由S305和S306的描述可见,在检测到目标接口的接口代码发生更新时,将更新后的接口代码以及更新后的接口代码的代码注释重新输入至接口文档生成工具,得到更新后的目标接口的接口文档,然后,可以将更新后的目标接口的接口文档上传至指定存储介质,以更新指定存储介质中的目标接口的接口文档,以及重新生成更新后的接口文档在指定存储介质中的存储地址,举例来说,当接口的描述或者接口参数变更了,只需要重新使用接口文档生成工具重新生成接口文档,将重新生成的接口文档上传到指定的存储介质。
通过图3所示流程可以看出,在本发明技术方案中,通过预设规范加载接口文档生成工具,将获取到的目标接口的接口代码以及接口代码的代码注释输入至接口文档生成工具,由此可以得到目标接口的接口文档,将该接口文档上传至指定存储介质的,并获得该接口文档的存储地址,在检测到目标接口的接口代码发生更新时,将更新后的接口代码以及代码注释重新输入至接口文档生成工具,得到更新后的目标接口的接口文档,将更新后的目标接口的接口文档上传至指定存储介质,以更新指定存储介质中的目标接口的接口文档,以及重新生成更新后的接口文档在指定存储介质中的存储地址,可以实现修改代码即可直接同步到文档,避免实际接口和接口文档不一致,避免了在修改代码时还需要修改接口文档的繁杂操作,减少了工作量,加快工作效率。
与前述接口文档的生成方法的实施例相对应,本发明还提供接口文档的生成装置的实施例框图。
参见图5,为本发明实施例提供的一种接口文档的生成装置的实施例框图。如图5所示,该装置包括:
加载模块501,用于加载接口文档生成工具;
获取模块502,用于获取目标接口的接口代码以及所述接口代码的代码注释;
确定模块503,用于将所述接口代码以及所述代码注释输入至所述接口文档生成工具,得到所述目标接口的接口文档。
在一可能的实施方式中,所述装置还包括:(图中并未示出)
存储模块,用于将所述接口文档存储至指定存储介质,并生成所述接口文档在所述指定存储介质中的存储地址。
在一可能的实施方式中,所述装置还包括:(图中并未示出)
下载模块,用于在所述将所述接口文档上传存储至指定存储介质,并生成面向所述指定存储介质的接口文档的文档地址之后,执行当接收到接口文档下载指令时,根据所述存储地址从所述指定存储介质中下载所述接口文档;
转换模块,用于对下载的接口文档进行格式转换,得到JSON格式的接口文档;
输出模块,用于通过浏览器输出所述JSON格式的接口文档。
在一可能的实施方式中,所述装置还包括:(图中并未示出)
文档确定模块,用于在检测到所述目标接口的接口代码发生更新时,将更新后的接口代码以及所述更新后的接口代码的代码注释重新输入至所述接口文档生成工具,得到更新后的所述目标接口的接口文档。
在一可能的实施方式中,所述装置还包括:(图中并未示出)
文档存储模块,用于在所述得到更新后的所述目标接口的接口文档之后,执行将更新后的所述目标接口的接口文档上传至所述指定存储介质,以更新所述指定存储介质中的所述目标接口的接口文档,以及重新生成所述更新后的接口文档在所述指定存储介质中的存储地址。
参见图6,为本发明实施例提供的一种电子设备的结构示意图,图6所示的电子设备600包括:至少一个处理器601、存储器602、至少一个网络接口604和其他用户接口603。电子设备600中的各个组件通过总线系统605耦合在一起。可理解,总线系统605用于实现这些组件之间的连接通信。总线系统605除包括数据总线之外,还包括电源总线、控制总线和状态信号总线。但是为了清楚说明起见,在图6中将各种总线都标为总线系统605。
其中,用户接口603可以包括显示器、键盘或者点击设备(例如,鼠标,轨迹球(trackball)、触感板或者触摸屏等)。
可以理解,本发明实施例中的存储器602可以是易失性存储器或非易失性存储器,或可包括易失性和非易失性存储器两者。其中,非易失性存储器可以是只读存储器(Read-OnlyMemory,ROM)、可编程只读存储器(ProgrammableROM,PROM)、可擦除可编程只读存储器(ErasablePROM,EPROM)、电可擦除可编程只读存储器(ElectricallyEPROM,EEPROM)或闪存。易失性存储器可以是随机存取存储器(RandomAccessMemory,RAM),其用作外部高速缓存。通过示例性但不是限制性说明,许多形式的RAM可用,例如静态随机存取存储器(StaticRAM,SRAM)、动态随机存取存储器(DynamicRAM,DRAM)、同步动态随机存取存储器(SynchronousDRAM,SDRAM)、双倍数据速率同步动态随机存取存储器(DoubleDataRateSDRAM,DDRSDRAM)、增强型同步动态随机存取存储器(Enhanced SDRAM,ESDRAM)、同步连接动态随机存取存储器(SynchlinkDRAM,SLDRAM)和直接内存总线随机存取存储器(DirectRambusRAM,DRRAM)。本文描述的存储器602旨在包括但不限于这些和任意其它适合类型的存储器。
在一些实施方式中,存储器602存储了如下的元素,可执行单元或者数据结构,或者他们的子集,或者他们的扩展集:操作系统6021和应用程序6022。
其中,操作系统6021,包含各种系统程序,例如框架层、核心库层、驱动层等,用于实现各种基础业务以及处理基于硬件的任务。应用程序6022,包含各种应用程序,例如媒体播放器(MediaPlayer)、浏览器(Browser)等,用于实现各种应用业务。实现本发明实施例方法的程序可以包含在应用程序6022中。
在本发明实施例中,通过调用存储器602存储的程序或指令,具体的,可以是应用程序6022中存储的程序或指令,处理器601用于执行各方法实施例所提供的方法步骤,例如包括:
加载接口文档生成工具;
获取目标接口的接口代码以及所述接口代码的代码注释;
将所述接口代码以及所述代码注释输入至所述接口文档生成工具,得到所述目标接口的接口文档。
上述本发明实施例揭示的方法可以应用于处理器601中,或者由处理器601实现。处理器601可能是一种集成电路芯片,具有信号的处理能力。在实现过程中,上述方法的各步骤可以通过处理器601中的硬件的集成逻辑电路或者软件形式的指令完成。上述的处理器601可以是通用处理器、数字信号处理器(DigitalSignalProcessor,DSP)、专用集成电路(ApplicationSpecificIntegratedCircuit,ASIC)、现成可编程门阵列(FieldProgrammableGateArray,FPGA)或者其他可编程逻辑器件、分立门或者晶体管逻辑器件、分立硬件组件。可以实现或者执行本发明实施例中的公开的各方法、步骤及逻辑框图。通用处理器可以是微处理器或者该处理器也可以是任何常规的处理器等。结合本发明实施例所公开的方法的步骤可以直接体现为硬件译码处理器执行完成,或者用译码处理器中的硬件及软件单元组合执行完成。软件单元可以位于随机存储器,闪存、只读存储器,可编程只读存储器或者电可擦写可编程存储器、寄存器等本领域成熟的存储介质中。该存储介质位于存储器602,处理器601读取存储器602中的信息,结合其硬件完成上述方法的步骤。
可以理解的是,本文描述的这些实施例可以用硬件、软件、固件、中间件、微码或其组合来实现。对于硬件实现,处理单元可以实现在一个或多个专用集成电路(ApplicationSpecificIntegratedCircuits,ASIC)、数字信号处理器(DigitalSignalProcessing,DSP)、数字信号处理设备(DSPDevice,DSPD)、可编程逻辑设备(ProgrammableLogicDevice,PLD)、现场可编程门阵列(Field-ProgrammableGateArray,FPGA)、通用处理器、控制器、微控制器、微处理器、用于执行本申请所述功能的其它电子单元或其组合中。
对于软件实现,可通过执行本文所述功能的单元来实现本文所述的技术。软件代码可存储在存储器中并通过处理器执行。存储器可以在处理器中或在处理器外部实现。
本实施例提供的电子设备可以是如图6中所示的电子设备,可执行如图1-3中接口文档的生成方法的所有步骤,进而实现图1-3中接口文档的生成方法的技术效果,具体请参照图1-3相关描述,为简洁描述,在此不作赘述。
本发明实施例还提供了一种存储介质(计算机可读存储介质)。这里的存储介质存储有一个或者多个程序。其中,存储介质可以包括易失性存储器,例如随机存取存储器;存储器也可以包括非易失性存储器,例如只读存储器、快闪存储器、硬盘或固态硬盘;存储器还可以包括上述种类的存储器的组合。
当存储介质中一个或者多个程序可被一个或者多个处理器执行,以实现上述在电子设备侧执行的接口文档的生成方法。
所述处理器用于执行存储器中存储的接口文档的生成程序,以实现以下在电子设备侧执行的接口文档的生成方法的步骤:
加载接口文档生成工具;
获取目标接口的接口代码以及所述接口代码的代码注释;
将所述接口代码以及所述代码注释输入至所述接口文档生成工具,得到所述目标接口的接口文档。
专业人员应该还可以进一步意识到,结合本文中所公开的实施例描述的各示例的单元及算法步骤,能够以电子硬件、计算机软件或者二者的结合来实现,为了清楚地说明硬件和软件的可互换性,在上述说明中已经按照功能一般性地描述了各示例的组成及步骤。这些功能究竟以硬件还是软件方式来执行,取决于技术方案的特定应用和设计约束条件。专业技术人员可以对每个特定的应用来使用不同方法来实现所描述的功能,但是这种实现不应认为超出本发明的范围。
结合本文中所公开的实施例描述的方法或算法的步骤可以用硬件、处理器执行的软件模块,或者二者的结合来实施。软件模块可以置于随机存储器(RAM)、内存、只读存储器(ROM)、电可编程ROM、电可擦除可编程ROM、寄存器、硬盘、可移动磁盘、CD-ROM、或技术领域内所公知的任意其它形式的存储介质中。
以上所述的具体实施方式,对本发明的目的、技术方案和有益效果进行了进一步详细说明,所应理解的是,以上所述仅为本发明的具体实施方式而已,并不用于限定本发明的保护范围,凡在本发明的精神和原则之内,所做的任何修改、等同替换、改进等,均应包含在本发明的保护范围之内。
Claims (10)
1.一种接口文档的生成方法,其特征在于,包括:
加载接口文档生成工具;
获取目标接口的接口代码以及所述接口代码的代码注释;
将所述接口代码以及所述代码注释输入至所述接口文档生成工具,得到所述目标接口的接口文档。
2.根据权利要求1所述的方法,其特征在于,所述方法还包括:
将所述接口文档存储至指定存储介质,并生成所述接口文档在所述指定存储介质中的存储地址。
3.根据权利要求2所述的方法,其特征在于,在所述将所述接口文档存储至指定存储介质,并生成所述接口文档在所述指定存储介质中的存储地址之后,所述方法还包括:
当接收到接口文档下载指令时,根据所述存储地址从所述指定存储介质中下载所述接口文档;
对下载的接口文档进行格式转换,得到JSON格式的接口文档;
通过浏览器输出所述JSON格式的接口文档。
4.根据权利要求2所述的方法,其特征在于,所述方法还包括:
在检测到所述目标接口的接口代码发生更新时,将更新后的接口代码以及所述更新后的接口代码的代码注释重新输入至所述接口文档生成工具,得到更新后的所述目标接口的接口文档。
5.根据权利要求4所述的方法,其特征在于,在所述得到更新后的所述目标接口的接口文档之后,所述方法还包括:
将更新后的所述目标接口的接口文档上传至所述指定存储介质,以更新所述指定存储介质中的所述目标接口的接口文档,以及重新生成所述更新后的接口文档在所述指定存储介质中的存储地址。
6.一种接口文档的生成装置,其特征在于,包括:
加载模块,用于加载接口文档生成工具;
获取模块,用于获取目标接口的接口代码以及所述接口代码的代码注释;
确定模块,用于将所述接口代码以及所述代码注释输入至所述接口文档生成工具,得到所述目标接口的接口文档。
7.根据权利要求6所述的装置,其特征在于,所述装置还包括:
存储模块,用于将所述接口文档存储至指定存储介质,并生成所述接口文档在所述指定存储介质中的存储地址。
8.根据权利要求7所述的装置,其特征在于,所述装置还包括:
下载模块,用于在所述将所述接口文档上传存储至指定存储介质,并生成面向所述指定存储介质的接口文档的文档地址之后,执行当接收到接口文档下载指令时,根据所述存储地址从所述指定存储介质中下载所述接口文档;
转换模块,用于对下载的接口文档进行格式转换,得到JSON格式的接口文档;
输出模块,用于通过浏览器输出所述JSON格式的接口文档。
9.一种电子设备,其特征在于,包括:处理器和存储器,所述处理器用于执行所述存储器中存储的接口文档的生成程序,以实现权利要求1~5中任一项所述的接口文档的生成方法。
10.一种存储介质,其特征在于,所述存储介质存储有一个或者多个程序,所述一个或者多个程序可被一个或者多个处理器执行,以实现权利要求1~5中任一项所述的接口文档的生成方法。
Priority Applications (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
CN202111416733.XA CN114201215A (zh) | 2021-11-19 | 2021-11-19 | 接口文档的生成方法、装置、电子设备及存储介质 |
Applications Claiming Priority (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
CN202111416733.XA CN114201215A (zh) | 2021-11-19 | 2021-11-19 | 接口文档的生成方法、装置、电子设备及存储介质 |
Publications (1)
Publication Number | Publication Date |
---|---|
CN114201215A true CN114201215A (zh) | 2022-03-18 |
Family
ID=80649039
Family Applications (1)
Application Number | Title | Priority Date | Filing Date |
---|---|---|---|
CN202111416733.XA Pending CN114201215A (zh) | 2021-11-19 | 2021-11-19 | 接口文档的生成方法、装置、电子设备及存储介质 |
Country Status (1)
Country | Link |
---|---|
CN (1) | CN114201215A (zh) |
Cited By (1)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
CN115904482A (zh) * | 2022-11-30 | 2023-04-04 | 杭州巨灵兽智能科技有限公司 | 接口文档生成方法、装置、设备及存储介质 |
-
2021
- 2021-11-19 CN CN202111416733.XA patent/CN114201215A/zh active Pending
Cited By (2)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
CN115904482A (zh) * | 2022-11-30 | 2023-04-04 | 杭州巨灵兽智能科技有限公司 | 接口文档生成方法、装置、设备及存储介质 |
CN115904482B (zh) * | 2022-11-30 | 2023-09-26 | 杭州巨灵兽智能科技有限公司 | 接口文档生成方法、装置、设备及存储介质 |
Similar Documents
Publication | Publication Date | Title |
---|---|---|
US10169034B2 (en) | Verification of backward compatibility of software components | |
US9128723B2 (en) | Method and apparatus for dynamic document object model (DOM) aware code editing | |
US9448770B2 (en) | Source code editor | |
US8819629B2 (en) | Automatically generating documentation on application programming interfaces | |
WO2017124952A1 (zh) | 一种网页脚本加载方法和装置 | |
US8645916B2 (en) | Crunching dynamically generated script files | |
CN109840083B (zh) | 网页组件模板构建方法、装置、计算机设备和存储介质 | |
CN107943465B (zh) | 一种生成html表单的方法及装置 | |
US11119896B1 (en) | Browser based visual debugging | |
CN112765023A (zh) | 测试用例生成方法、装置 | |
US9141344B2 (en) | Hover help support for application source code | |
CN110780860A (zh) | 建表脚本的生成方法、装置、计算机设备及存储介质 | |
CN114138244A (zh) | 模型类文件自动生成方法、装置、存储介质及电子设备 | |
CN114153459A (zh) | 接口文档生成方法及装置 | |
US8191041B2 (en) | Javascript pre-processing framework | |
US11604662B2 (en) | System and method for accelerating modernization of user interfaces in a computing environment | |
CN114201215A (zh) | 接口文档的生成方法、装置、电子设备及存储介质 | |
CN114253537A (zh) | 表单生成方法及装置、电子设备和存储介质 | |
CN112559026B (zh) | 基于api接口的原生能力拓展方法、设备及存储介质 | |
CN113296752A (zh) | 生成api文档的方法、系统、设备及存储介质 | |
CN111736812A (zh) | 文档代码执行方法、装置、计算机设备及存储介质 | |
US9727397B2 (en) | Container-less JSP template | |
CN111078529A (zh) | 客户端写入模块测试方法、装置、电子设备 | |
CN114492473A (zh) | 语言字符串的翻译方法、装置、计算机设备及存储介质 | |
US20140372982A1 (en) | Standardization of variable names in an integrated development environment |
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 |