CN108268570B - 一种开发接口的方法及装置 - Google Patents

Abstract

本发明公开了一种开发接口的方法及装置，应用于接口开发技术领域，所述方法包括：监听是否存在来自客户端的用于查看与接口对应的模拟数据的查看请求；当存在所述查看请求时，在模拟数据库中对所述查看请求进行地址匹配；当匹配成功时，从与所述查看请求匹配的地址中解析出用于查找所述模拟数据的查找标识；在所述模拟数据库中查找与所述查找标识对应的所述模拟数据；将查找到的所述模拟数据返回给所述客户端。本发明实现了客户端和服务器能够并行对接口进行开发的技术效果，提高了开发效率，节省了开发时间。

Description

一种开发接口的方法及装置

技术领域

本发明涉及接口开发技术领域，尤其涉及一种开发接口的方法及装置。

背景技术

现有技术开发接口的实现过程包括：步骤一：服务器侧开发人员在程序开发前定义好接口的地址、是否缓存、请求场景、请求参数和返回结果，步骤二：服务器侧开发人员进行接口开发，步骤三：服务器侧开发人员在数据库中插入测试数据，步骤四：服务器侧开发人员通知客户端侧开发人员接口开发完毕，客户端侧开发人员可以进行后续开发。然而，现有技术在执行步骤二和步骤三时，客户端侧的开发人员只能等待，因此浪费了开发时间，降低了开发效率。

发明内容

鉴于上述问题，提出了本发明以便提供一种克服上述问题或者至少部分地解决上述问题的开发接口的方法及装置。

本发明实施例提供一种开发接口的方法，所述方法包括：

监听是否存在来自客户端的用于查看与接口对应的模拟数据的查看请求；

当存在所述查看请求时，在模拟数据库中对所述查看请求进行地址匹配；

当匹配成功时，从与所述查看请求匹配的地址中解析出用于查找所述模拟数据的查找标识；

在所述模拟数据库中查找与所述查找标识对应的所述模拟数据；

将查找到的所述模拟数据返回给所述客户端。

优选的，所述当存在所述查看请求时，在模拟数据库中对所述查看请求进行地址匹配，包括：

当存在所述查看请求时，利用Beego将所述查看请求的地址路由到所述模拟数据库中，在所述模拟数据库中对所述查看请求的地址进行地址匹配。

优选的，所述查找标识包括查找项目名和查询统一资源标识符串。

优选的，在所述监听是否存在用于查看与接口对应的模拟数据的查看请求之前，所述方法还包括：

通过钩子程序从客户端获取上传代码；

判断所述上传代码与服务器中的当前代码是否相同；

若不相同，则，利用所述上传代码对所述当前代码进行更新。

优选的，在所述利用所述上传代码对所述当前代码进行更新之前，所述方法还包括：

对所述上传代码中包含的用于表征接口配置情况的接口配置数据进行提取；

判断是否提取成功；

若提取成功，则，根据提取出的所述接口配置数据生成接口文档，同时将所述接口配置数据写入所述模拟数据库中；

若提取失败，则，生成错误日志，并发送包含所述错误日志的反馈信息给所述客户端。

基于同一发明构思，本发明实施例还提供一种开发接口的装置，所述装置包括：

监听模块，用于监听是否存在来自客户端的用于查看与接口对应的模拟数据的查看请求；

匹配模块，用于当存在所述查看请求时，在模拟数据库中对所述查看请求进行地址匹配；

解析模块，用于当匹配成功时，从与所述查看请求匹配的地址中解析出用于查找所述模拟数据的查找标识；

查找模块，用于在所述模拟数据库中查找与所述查找标识对应的所述模拟数据；

返回模块，用于将查找到的所述模拟数据返回给所述客户端。

优选的，所述匹配模块，具体用于：

当存在所述查看请求时，利用Beego将所述查看请求的地址路由到所述模拟数据库中，在所述模拟数据库中对所述查看请求的地址进行地址匹配。

优选的，所述查找标识包括查找项目名和查询统一资源标识符串。

优选的，所述装置还包括：

获取模块，用于通过钩子程序从客户端获取上传代码；

第一判断模块，用于判断所述上传代码与服务器中的当前代码是否相同；

更新模块，用于若不相同，则，利用所述上传代码对所述当前代码进行更新。

优选的，所述装置还包括：

提取模块，用于对所述上传代码中包含的用于表征接口配置情况的接口配置数据进行提取；

第二判断模块，用于判断是否提取成功；

第一处理模块，用于若提取成功，则，根据提取出的所述接口配置数据生成接口文档，同时将所述接口配置数据写入所述模拟数据库中；

第二处理模块，用于若提取失败，则，生成错误日志，并发送包含所述错误日志的反馈信息给所述客户端。

本发明实施例中的一个或多个技术方案，至少具有如下技术效果或优点：

在本发明中，客户端可以随时向服务器发起用于查看与接口对应的模拟数据的查看请求，服务器在监听到存在查看请求时，在模拟数据库中对查看请求进行地址匹配，当匹配成功时，从与查看请求匹配的地址中解析出用于查找模拟数据的查找标识，接着在模拟数据库中查找与查找标识对应的模拟数据，最后将查找到的模拟数据返回给客户端，客户端根据返回的模拟数据能够对接口进行开发，从而，本发明实现了客户端和服务器能够并行对接口进行开发的技术效果，提高了开发效率，节省了开发时间。

附图说明

通过阅读下文优选实施方式的详细描述，各种其他的优点和益处对于本领域普通技术人员将变得清楚明了。附图仅用于示出优选实施方式的目的，而并不认为是对本发明的限制。而且在整个附图中，用相同的参考图形表示相同的部件。在附图中：

图1示出了本发明实施例的一种开发接口文档的方法的流程图；

图2示出了本发明实施例的一种开发接口文档的装置的结构图。

具体实施方式

下面将参照附图更详细地描述本公开的示例性实施例。虽然附图中显示了本公开的示例性实施例，然而应当理解，可以以各种形式实现本公开而不应被这里阐述的实施例所限制。相反，提供这些实施例是为了能够更透彻地理解本公开，并且能够将本公开的范围完整的传达给本领域的技术人员。

本发明实施例提供一种开发接口文档的方法，所述方法应用于服务器中，该服务器能够与客户端进行交互。如图1所示，所述方法包括：

步骤101：监听是否存在来自客户端的用于查看与接口对应的模拟数据的查看请求。

在本发明的实施例中，可以在服务器中预先设定一接收端口，该接收端口用于接收客户端发送的查看请求，接收端口的端口号可以为9096。具体来讲，客户端开发人员在客户端中访问某一接口的接口文档时，将会生成用于查看与该接口对应的模拟数据的查看请求。其中，本发明中的模拟数据即为Mock数据，Mock数据为用于模拟后台的数据。接着，客户端将查看请求发送至服务器的接收端口，同时，服务器实时监听接收端口是否存在查看请求。

步骤102：当存在所述查看请求时，在模拟数据库中对所述查看请求进行地址匹配。

在本发明的实施例中，当存在查看请求时，利用Beego将查看请求的地址路由到模拟数据库中，在模拟数据库中对查看请求的地址进行地址匹配。其中，模拟数据库即为Mock数据库，Beego是一种快速开发Go应用的http框架，Beego具有路由效率高的优点，利用Beego进行路由地址的具体过程如下：先获取“github.com/astaxie/beego”包，接着，使用beego(beego.Run())进行路由地址匹配，beego.Router(“/mock/”+data+”/*.*”,&controllers.MockController{})为路由地址匹配时采用的函数，在地址匹配时，判断模拟数据库中是否存在与查看请求相匹配的地址，如果存在，则表明匹配成功，如果不存在，则表明匹配失败。其中，模拟数据库中与查看请求相匹配的地址可以为与查看请求相同的地址，即，判断模拟数据库中是否存在与查看请求的地址相同的地址，如果存在，则表明匹配成功，如果不存在，则表明匹配不成功。

步骤103：当匹配成功时，从所述查看请求的地址中解析出用于查找所述模拟数据的查找标识。

在本发明的实施例中，查找标识包括查找项目名和查询统一资源标识符串。当匹配成功时，将与查看请求匹配的地址路由到Mock控制器中进行处理，也即，将查看请求的地址路由到Mock控制器中进行处理，Mock控制器从查询请求的地址中解析出查询项目名和查询统一资源标识符串。具体地，在Mock控制器中根据c.Ctx.Request.RequestURI函数获得查看请求的地址的统一资源标识符(URI，Uniform Resource Identifier)，接着，通过识别查看请求的地址中的分隔符“/”，将查看请求的地址分割成包含若干元素的数组，并将分割得到的数组中的第二个元素作为查询项目名，即project，并对分割得到的数组中的第三个元素以及第三个元素之后的所有元素进行拼接，得到查询统一资源标识符串，即uriString()。

步骤104：在所述模拟数据库中查找与所述查找标识对应的所述模拟数据。

步骤105：将查找到的所述模拟数据返回给所述客户端。

在本发明的实施例中，在查找到Mock数据之后，可以先将Mock数据转换成JSON格式，再将转换后得到的数据返回给客户端进行展示。

另外，在本发明中，针对客户端向服务器发送上传代码的情况，在监听是否存在来自客户端的用于查看与接口对应的模拟数据的查看请求之前，所述方法还包括：

通过钩子程序从客户端获取上传代码；

判断所述上传代码与服务器中的当前代码是否相同；

若不相同，则，利用所述上传代码对所述当前代码进行更新。

在本发明的实施例中，服务器配置有钩子程序(Hook)，通过Hook从客户端拉取上传代码。在拉取到上传代码之后，判断上传代码是否与服务器中的当前代码相同，如果不相同，则通过代码版本控制系统(SVN，Subversion)对代码进行更新。若相同，则不动作。

进一步，在利用上传代码对当前代码进行更新之后，所述方法还包括：对上传代码中包含的用于表征接口配置情况的接口配置数据进行提取，并判断是否提取成功，若提取成功，则根据提取出的接口配置数据生成接口文档，同时将所述接口配置数据写入所述模拟数据库中，若提取失败，则生成错误日志，并发送包含错误日志的反馈信息给客户端。

具体地，对上传代码中包含的用于表征接口配置情况的接口配置数据进行提取的过程，包括：循环遍历上传代码，读取上传代码中的注释，通过doc.New(),input.Parse(docs,0)解释注释，并进行分析，分离出接口的地址、是否缓存、请求场景、请求参数和返回结果等接口配置数据，在一种优选的实施例中，可以先将接口配置数据转换成JSON格式，再利用JSON格式的数据生成接口文档以及写入到Mock数据库中。若提取接口配置数据失败，则获取日志filepath.Join，打开日志os.OpenFile(path,os.O_WRONLY,0644)，发送邮件mail.NewEmail(“邮件地址”,“文档生成报错”,byteString(b))，byteString(b)是将byte格式转化为string格式，其中b为错误信息。

本发明通过检测上传代码和当前代码是否相同，若不相同则进行代码更新，进行接口文档的重写，保持了接口数据的一致性和正确性。

基于同一发明构思，本发明实施例还提供一种开发接口的装置，如图2所示，所述装置包括：

监听模块301，用于监听是否存在来自客户端的用于查看与接口对应的模拟数据的查看请求；

匹配模块302，用于当存在所述查看请求时，在模拟数据库中对所述查看请求进行地址匹配；

解析模块303，用于当匹配成功时，从与所述查看请求匹配的地址中解析出用于查找所述模拟数据的查找标识；

查找模块304，用于在所述模拟数据库中查找与所述查找标识对应的所述模拟数据；

返回模块305，用于将查找到的所述模拟数据返回给所述客户端。

其中，匹配模块302，具体用于：

当存在所述查看请求时，利用Beego将所述查看请求的地址路由到所述模拟数据库中，在所述模拟数据库中对所述查看请求的地址进行地址匹配。

其中，所述查找标识包括查找项目名和查询统一资源标识符串。

其中，所述装置还包括：

获取模块，用于通过钩子程序从客户端获取上传代码；

第一判断模块，用于判断所述上传代码与服务器中的当前代码是否相同；

更新模块，用于若不相同，则，利用所述上传代码对所述当前代码进行更新。

其中，所述装置还包括：

提取模块，用于对所述上传代码中包含的用于表征接口配置情况的接口配置数据进行提取；

第二判断模块，用于判断是否提取成功；

第一处理模块，用于若提取成功，则，根据提取出的所述接口配置数据生成接口文档，同时将所述接口配置数据写入所述模拟数据库中；

第二处理模块，用于若提取失败，则，生成错误日志，并发送包含所述错误日志的反馈信息给所述客户端。

本发明实施例中的一个或多个技术方案，至少具有如下技术效果或优点：

在本发明中，客户端可以随时向服务器发起用于查看与接口对应的模拟数据的查看请求，服务器在监听到存在查看请求时，在模拟数据库中对查看请求进行地址匹配，当匹配成功时，从与查看请求匹配的地址中解析出用于查找模拟数据的查找标识，接着在模拟数据库中查找与查找标识对应的模拟数据，最后将查找到的模拟数据返回给客户端，客户端根据返回的模拟数据能够对接口进行开发，从而，本发明实现了客户端和服务器能够并行对接口进行开发的技术效果，提高了开发效率，节省了开发时间。

在此提供的算法和显示不与任何特定计算机、虚拟系统或者其它设备固有相关。各种通用系统也可以与基于在此的示教一起使用。根据上面的描述，构造这类系统所要求的结构是显而易见的。此外，本发明也不针对任何特定编程语言。应当明白，可以利用各种编程语言实现在此描述的本发明的内容，并且上面对特定语言所做的描述是为了披露本发明的最佳实施方式。

在此处所提供的说明书中，说明了大量具体细节。然而，能够理解，本发明的实施例可以在没有这些具体细节的情况下实践。在一些实例中，并未详细示出公知的方法、结构和技术，以便不模糊对本说明书的理解。

类似地，应当理解，为了精简本公开并帮助理解各个发明方面中的一个或多个，在上面对本发明的示例性实施例的描述中，本发明的各个特征有时被一起分组到单个实施例、图、或者对其的描述中。然而，并不应将该公开的方法解释成反映如下意图：即所要求保护的本发明要求比在每个权利要求中所明确记载的特征更多的特征。更确切地说，如下面的权利要求书所反映的那样，发明方面在于少于前面公开的单个实施例的所有特征。因此，遵循具体实施方式的权利要求书由此明确地并入该具体实施方式，其中每个权利要求本身都作为本发明的单独实施例。

本领域那些技术人员可以理解，可以对实施例中的设备中的模块进行自适应性地改变并且把它们设置在与该实施例不同的一个或多个设备中。可以把实施例中的模块或单元或组件组合成一个模块或单元或组件，以及此外可以把它们分成多个子模块或子单元或子组件。除了这样的特征和/或过程或者单元中的至少一些是相互排斥之外，可以采用任何组合对本说明书(包括伴随的权利要求、摘要和附图)中公开的所有特征以及如此公开的任何方法或者设备的所有过程或单元进行组合。除非另外明确陈述，本说明书(包括伴随的权利要求、摘要和附图)中公开的每个特征可以由提供相同、等同或相似目的的替代特征来代替。

此外，本领域的技术人员能够理解，尽管在此所述的一些实施例包括其它实施例中所包括的某些特征而不是其它特征，但是不同实施例的特征的组合意味着处于本发明的范围之内并且形成不同的实施例。例如，在下面的权利要求书中，所要求保护的实施例的任意之一都可以以任意的组合方式来使用。

本发明的各个部件实施例可以以硬件实现，或者以在一个或者多个处理器上运行的软件模块实现，或者以它们的组合实现。本领域的技术人员应当理解，可以在实践中使用微处理器或者数字信号处理器(DSP)来实现根据本发明实施例的开发接口的装置中的一些或者全部部件的一些或者全部功能。本发明还可以实现为用于执行这里所描述的方法的一部分或者全部的设备或者装置程序(例如，计算机程序和计算机程序产品)。这样的实现本发明的程序可以存储在计算机可读介质上，或者可以具有一个或者多个信号的形式。这样的信号可以从因特网网站上下载得到，或者在载体信号上提供，或者以任何其他形式提供。

应该注意的是上述实施例对本发明进行说明而不是对本发明进行限制，并且本领域技术人员在不脱离所附权利要求的范围的情况下可设计出替换实施例。在权利要求中，不应将位于括号之间的任何参考符号构造成对权利要求的限制。单词“包含”不排除存在未列在权利要求中的元件或步骤。位于元件之前的单词“一”或“一个”不排除存在多个这样的元件。本发明可以借助于包括有若干不同元件的硬件以及借助于适当编程的计算机来实现。在列举了若干装置的单元权利要求中，这些装置中的若干个可以是通过同一个硬件项来具体体现。单词第一、第二、以及第三等的使用不表示任何顺序。可将这些单词解释为名称。

Claims (2)

1.一种开发接口的方法，其特征在于，所述方法包括：

监听是否存在来自客户端的用于查看与接口对应的模拟数据的查看请求，所述模拟数据为Mock数据，所述Mock数据为用于模拟后台的数据；

当存在所述查看请求时，利用Beego将所述查看请求的地址路由到Mock数据库中，在所述Mock数据库中对所述查看请求的地址进行地址匹配；其中，所述利用Beego将所述查看请求的地址路由到Mock数据库中，在所述Mock数据库中对所述查看请求的地址进行地址匹配，包括：获取“github.com/astaxie/beego”包，使用beego(beego.Run())进行地址匹配，beego.Router(“/mock/”+data+”/*.*”,&controllers.MockController{})为地址匹配时采用的函数，在地址匹配时，判断所述Mock数据库中是否存在与所述查看请求的地址相同的地址，如果存在，则表明匹配成功，如果不存在，则表明匹配不成功；

当匹配成功时，将所述查看请求的地址路由到Mock控制器中，在所述Mock控制器中根据c.Ctx.Request.RequestURI函数获得所述查看请求的地址的统一资源标识符(URI，Uniform Resource Identifier)，通过识别分隔符，将所述查看请求的地址分割成数组，并将分割得到的数组中的第二个元素作为查找项目名，并对分割得到的数组中的第三个元素以及第三个元素之后的所有元素进行拼接，得到查询统一资源标识符串；

在所述Mock数据库中查找与所述查找项目名和查询统一资源标识符串对应的所述Mock数据；

将查找到的所述Mock数据返回给所述客户端；

其中，在所述监听是否存在用于查看与接口对应的模拟数据的查看请求之前，所述方法还包括：

通过钩子程序从客户端获取上传代码；

判断所述上传代码与服务器中的当前代码是否相同；

若不相同，则，利用所述上传代码对所述当前代码进行更新；

其中，在所述利用所述上传代码对所述当前代码进行更新之前，所述方法还包括：

对所述上传代码中包含的用于表征接口配置情况的接口配置数据进行提取；其中，所述对上传代码中包含的用于表征接口配置情况的接口配置数据进行提取，包括：循环遍历所述上传代码，读取所述上传代码中的注释，通过doc.New(),input.Parse(docs,0)解释注释并进行分析，分离出所述接口配置数据；

判断是否提取成功；

若提取成功，则，根据提取出的所述接口配置数据生成接口文档，同时将所述接口配置数据写入所述Mock数据库中；

若提取失败，则，生成错误日志，并发送包含所述错误日志的反馈信息给所述客户端。

2.一种开发接口的装置，其特征在于，所述装置包括：

监听模块，用于监听是否存在来自客户端的用于查看与接口对应的模拟数据的查看请求，所述模拟数据为Mock数据，所述Mock数据为用于模拟后台的数据；

匹配模块，用于当存在所述查看请求时，利用Beego将所述查看请求的地址路由到Mock数据库中，在所述Mock数据库中对所述查看请求的地址进行地址匹配；其中，所述利用Beego将所述查看请求的地址路由到Mock数据库中，在所述Mock数据库中对所述查看请求的地址进行地址匹配，包括：获取“github.com/astaxie/beego”包，使用beego(beego.Run())进行地址匹配，beego.Router(“/mock/”+data+”/*.*”,&controllers.MockController{})为地址匹配时采用的函数，在地址匹配时，判断所述Mock数据库中是否存在与所述查看请求的地址相同的地址，如果存在，则表明匹配成功，如果不存在，则表明匹配不成功；；

解析模块，用于当匹配成功时，将所述查看请求的地址路由到Mock控制器中，在所述Mock控制器中根据c.Ctx.Request.RequestURI函数获得所述查看请求的地址的统一资源标识符(URI，Uniform Resource Identifier)，通过识别分隔符，将所述查看请求的地址分割成数组，并将分割得到的数组中的第二个元素作为查找项目名，并对分割得到的数组中的第三个元素以及第三个元素之后的所有元素进行拼接，得到查询统一资源标识符串；

查找模块，用于在所述Mock数据库中查找与所述查找项目名和查询统一资源标识符串对应的所述Mock数据；

返回模块，用于将查找到的所述Mock数据返回给所述客户端；

获取模块，用于通过钩子程序从客户端获取上传代码；

第一判断模块，用于判断所述上传代码与服务器中的当前代码是否相同；

更新模块，用于若不相同，则，利用所述上传代码对所述当前代码进行更新；

提取模块，用于对所述上传代码中包含的用于表征接口配置情况的接口配置数据进行提取；其中，所述对上传代码中包含的用于表征接口配置情况的接口配置数据进行提取，包括：循环遍历所述上传代码，读取所述上传代码中的注释，通过doc.New(),input.Parse(docs,0)解释注释并进行分析，分离出所述接口配置数据；

第二判断模块，用于判断是否提取成功；

第一处理模块，用于若提取成功，则，根据提取出的所述接口配置数据生成接口文档，同时将所述接口配置数据写入所述模拟数据库中；

第二处理模块，用于若提取失败，则，生成错误日志，并发送包含所述错误日志的反馈信息给所述客户端。

Images