基于yapi的前端api接口自动生成方法及装置
技术领域
本申请涉及计算机
技术领域
，尤其涉及一种基于YAPI的前端API接口自动生成方法及装置。背景技术
在系统开发过程中，开发一个新模块过程中，通常会涉及到几个或者几十个和服务器端交互的API接口，而且API接口需要前端人员手动一个个添加。此外，在系统开发迭代过程中，由于参与开发人员较多，针对前端开发领域，定义和服务器端交互的HTTP请求时，如果没有一定的API接口规则，维护起来比较吃力。因此，目前亟需一种便于前端技术人员使用的API接口生成技术，以提高开发效率。
发明内容
本申请提供一种基于YAPI的前端API接口自动生成方法及装置，以解决目前没有便于前端技术人员使用的API接口生成技术导致的开发效率受限的问题。
本申请的上述目的是通过以下技术方案实现的：
第一方面，本申请实施例提供一种基于YAPI的前端API接口自动生成方法，其包括：
根据需求从YAPI平台获取接口文档；
对获取到的接口文档进行批量解析，得到接口信息；
利用所述接口信息自动生成所需的API接口。
可选的，YAPI平台中的接口文档为后端开发人员预先定义并存储的。
可选的，所述接口文档包括json格式的文档数据。
可选的，得到的所述接口信息包括方法名、参数和返回值。
第二方面，本申请实施例还提供一种基于YAPI的前端API接口自动生成装置，其包括：
获取模块，用于根据需求从YAPI平台获取预先定义的接口文档；
解析模块，用于对获取到的接口文档进行批量解析，得到接口信息；
生成模块，用于利用所述接口信息自动生成所需的API接口。
本申请的实施例提供的技术方案可以包括以下有益效果：
本申请的实施例提供的技术方案，当需要生成API接口时，首先根据需求从YAPI平台获取接口文档，并对获取到的接口文档进行批量解析，得到接口信息，然后利用接口信息自动生成所需的API接口。如此设置，可以自动生成符合要求的API接口，从而简化前端人员的操作，十分方便。
应当理解的是，以上的一般描述和后文的细节描述仅是示例性和解释性的，并不能限制本申请。
附图说明
此处的附图被并入说明书中并构成本说明书的一部分，示出了符合本申请的实施例，并与说明书一起用于解释本申请的原理。
图1为本申请实施例提供的一种基于YAPI的前端API接口自动生成方法的流程示意图；
图2为本申请实施例提供的一种基于YAPI的前端API接口自动生成装置的结构示意图。
具体实施方式
这里将详细地对示例性实施例进行说明，其示例表示在附图中。下面的描述涉及附图时，除非另有表示，不同附图中的相同数字表示相同或相似的要素。以下示例性实施例中所描述的实施方式并不代表与本申请相一致的所有实施方式。相反，它们仅是与如所附权利要求书中所详述的、本申请的一些方面相一致的装置和方法的例子。
为了解决背景技术中提出的问题，便于前端开发人员在系统开发和迭代过程中更加简便地生成API接口，本申请提供一种基于YAPI的前端API接口自动生成方法及装置，以下通过实施例进行详细说明。
实施例
参照图1，图1为本申请实施例提供的一种基于YAPI的前端API接口自动生成方法的流程示意图。如图1所示，该方法至少包括以下步骤：
S101：根据需求从YAPI平台获取接口文档；
其中，YAPI平台中的接口文档为后端开发人员预先定义并存储的，也即，后端开发人员需要根据实际情况，预先定义好所有可能涉及到的接口文档，并存储在YAPI平台中。YAPI平台是高效、易用、功能强大的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护API，YApi还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。
一些实施例中，上述的接口文档包括json格式的文档数据。json格式(JavaScriptObject Notation,JS对象简谱)是一种轻量级的数据交换格式。简洁和清晰的层次结构使得JSON成为理想的数据交换语言。易于人阅读和编写，同时也易于机器解析和生成，并有效地提升网络传输效率。
当前端开发人员需要利用YAPI平台生成API接口时，可以通过本地程序获取YAPI平台上的接口文档。
S102：对获取到的接口文档进行批量解析，得到接口信息；
具体的，当本地程序获取到用户所需的接口文档后，可以自动进行批量解析，从而得到对应的接口信息，比如，一些实施例中，得到的接口信息可以包括方法名、参数和返回值。
S103：利用所述接口信息自动生成所需的API接口。
其中，得到的接口信息可以自动批量生成一或多个API接口，而无需用户进行复杂操作。
本申请的实施例提供的技术方案可以包括以下有益效果：
本申请的实施例提供的技术方案，当需要生成API接口时，首先根据需求从YAPI平台获取接口文档，并对获取到的接口文档进行批量解析，得到接口信息，然后利用接口信息自动生成所需的API接口。如此设置，可以自动生成符合要求的API接口，从而简化前端人员的操作，十分方便。
此外，基于相同的发明构思，对应于上述实施例的基于YAPI的前端API接口自动生成方法，本申请实施例还提供一种基于YAPI的前端API接口自动生成装置。
参照图2，图2为本申请实施例提供的一种基于YAPI的前端API接口自动生成装置的结构示意图。如图2所示，该装置至少包括以下结构：
获取模块21，用于根据需求从YAPI平台获取预先定义的接口文档；
解析模块22，用于对获取到的接口文档进行批量解析，得到接口信息；
生成模块23，用于利用所述接口信息自动生成所需的API接口。
其中，YAPI平台中的接口文档为后端开发人员预先定义并存储的。可选的，接口文档包括json格式的文档数据。得到的所述接口信息包括方法名、参数和返回值。
具体的，上述装置中的各功能模块所执行的步骤的具体实现方法可以参照前述方法实施例中的相应内容，此处不再赘述。
通过上述方案，可以自动生成符合要求的API接口，从而简化前端人员的操作，十分方便。
可以理解的是，上述各实施例中相同或相似部分可以相互参考，在一些实施例中未详细说明的内容可以参见其他实施例中相同或相似的内容。
需要说明的是，在本申请的描述中，术语“第一”、“第二”等仅用于描述目的，而不能理解为指示或暗示相对重要性。此外，在本申请的描述中，除非另有说明，“多个”的含义是指至少两个。
流程图中或在此以其他方式描述的任何过程或方法描述可以被理解为，表示包括一个或更多个用于实现特定逻辑功能或过程的步骤的可执行指令的代码的模块、片段或部分，并且本申请的优选实施方式的范围包括另外的实现，其中可以不按所示出或讨论的顺序，包括根据所涉及的功能按基本同时的方式或按相反的顺序，来执行功能，这应被本申请的实施例所属技术领域的技术人员所理解。
应当理解，本申请的各部分可以用硬件、软件、固件或它们的组合来实现。在上述实施方式中，多个步骤或方法可以用存储在存储器中且由合适的指令执行系统执行的软件或固件来实现。例如，如果用硬件来实现，和在另一实施方式中一样，可用本领域公知的下列技术中的任一项或他们的组合来实现：具有用于对数据信号实现逻辑功能的逻辑门电路的离散逻辑电路，具有合适的组合逻辑门电路的专用集成电路，可编程门阵列(PGA)，现场可编程门阵列(FPGA)等。
本技术领域的普通技术人员可以理解实现上述实施例方法携带的全部或部分步骤是可以通过程序来指令相关的硬件完成，所述的程序可以存储于一种计算机可读存储介质中，该程序在执行时，包括方法实施例的步骤之一或其组合。
此外，在本申请各个实施例中的各功能单元可以集成在一个处理模块中，也可以是各个单元单独物理存在，也可以两个或两个以上单元集成在一个模块中。上述集成的模块既可以采用硬件的形式实现，也可以采用软件功能模块的形式实现。所述集成的模块如果以软件功能模块的形式实现并作为独立的产品销售或使用时，也可以存储在一个计算机可读取存储介质中。
上述提到的存储介质可以是只读存储器，磁盘或光盘等。
在本说明书的描述中，参考术语“一个实施例”、“一些实施例”、“示例”、“具体示例”、或“一些示例”等的描述意指结合该实施例或示例描述的具体特征、结构、材料或者特点包含于本申请的至少一个实施例或示例中。在本说明书中，对上述术语的示意性表述不一定指的是相同的实施例或示例。而且，描述的具体特征、结构、材料或者特点可以在任何的一个或多个实施例或示例中以合适的方式结合。
尽管上面已经示出和描述了本申请的实施例，可以理解的是，上述实施例是示例性的，不能理解为对本申请的限制，本领域的普通技术人员在本申请的范围内可以对上述实施例进行变化、修改、替换和变型。
