专利名称：一种基于开放平台的接口生成校验方法及设备的制作方法
技术领域：
本发明属于计算机领域，具体地说，涉及一种基于开放平台的接口生成校验方法及设备。
背景技术：
在现有的互联网时代，将网站的服务封装成一系列计算机易识别的API (应用编程接口)开放出去，提供给第三方开发者使用，这种行为叫做Open API，提供Open API的平台被称为开放平台。第三方开发者，即已经提供互联网应用程序或即将提供互联网应用程序的个人与单位，想将自有的应用程序放置在开放平台上，进而提供给最终用户。最终用户，即使用开放平台所提供的应用程序的群体。具有Open API的网站不仅能提供对网页的简单访问，还可以进行复杂的数据交互等其他操作，所述网站从而转换为与操作系统等价的开发平台，第三方开发者可以基于这些已经存在的且公开的网站而开发许多丰富多彩的应用。在众多的互联网开放平台中，依据所服务的主体不同，也将开放平台分为两类，一类是中心化开放平台，平台的Open API主要用于针对自身的网站提供所开发的应用程序的业务功能，所述应用程序接入这些API从而集成相应的功能，在开放平台上展现提供服务；还有一种是分布式开放平台，这类平台提供一个标准API并串联第三方开发者使用所述标准API开发应用程序，在审核所述应用程序的安全性和稳定性之后，即可将这些应用程序推向所有支持该标准API的网站。第三方开发者将应用程序接入开放平台的某项功能(即相应的Open API)时，需要根据自身业务需求和开放平台的相关引导选择合适的接入流程，并在接入流程中需要理解具有相关性的多个Open API定义，对于Open API的使用是第三方开发者接入开放平台的主要工作之一。一般情况下，开放平台会为第三方开发者提供详尽的Open API说明文档和接入教程以指导其将应用程序接入开放平台的相应功能，但是开发者对接入流程以及OpenAPI定义的不熟悉，不可避免地会导致在应用程序接入相应功能时生成错误的API从而导致接入开放平台失败，错误类型包括=API路径错误、API涉及的域名错误、API相关元素错误等。现阶段，第三方开发者将应用程序接入开放平台的某项功能时需要按照Open API说明文档和接入教程编写生成相应API。如果所述API的编写符合规则要求，访问所述API会直接开启对应的页面。但是当所述API的生成存在错误时，如果是前端访问所述API，一般会在页面上给出错误码或错误描述，如果是后端访问所述API，会直接返回错误码或错误描述。在第三方开发者拿到错误码或错误描述后，联系相关运营人员或者技术客服进行咨询，然后根据所得到的咨询结果进行修改并重新生成API然后再进行访问。有可能依然存在错误修改再次咨询后修改，这个过程可能需要经过几轮反复最终才能使应用程序成功接 入 API。显然，在接入API的过程中，生成API过程的复杂直接导致出现错误的情况较多，而开发者在遇到问题时又缺乏相关错误的处理经验，而且受前端展示方式所限，第三方开发者很难得到错误的详尽的信息。而在获取到错误信息之后，现有流程中缺乏快速简便的错误分析工具，而只采取人工交互的行为进行一对一讲解，人工咨询的解决方式会大大降低开发者的开发效率；而且在大量的问题反馈到技术客服时，也会增加开放平台技术客服的工作量。
发明内容
有鉴于此，本发明所要解决的技术问题是提供了一种基于开放平台的接口生成校验方法及设备，错误校验和接口生成的组合可以贯穿在第三方开发者开始接入和接入过程中，接口生成机制保证第三方开发者生成正确接口，错误校验机制保证第三方开发者在生成了错误接口时提供简便快速的解决 方案，从而确保第三方开发者开发的顺畅性，也减轻了开放平台技术客服的工作压力。为了解决上述技术问题，本发明公开了一种基于开放平台的接口生成校验设备，包括设置模块、配置模块、提示模块、接口生成模块和错误校验模块，其中，所述设置模块，用于预先设置所述元素的标准格式；所述配置模块，用于根据每种类型的接口的构造规则分别获取生成每种类型的接口所需的元素；所述提示模块，用于在应用程序接入接口时提示输入与待接入接口的类型相应的元素，所接收到的元素的输入内容与所述应用程序相关；所述接口生成模块，用于根据所述元素及与所述接口的类型相应的构造规则生成所述接口 ；所述错误校验模块，用于在访问所述接口失败时，根据所述标准格式对所述元素所涉及的字符串进行校验，根据校验结果分析出所述接口访问失败的因素。进一步地,所述元素,包括与所述接口相关的域名、路径和/或交互参数。进一步地，所述错误校验模块，用于依照所述元素中域名、路径、交互参数的顺序采用职责链方式，根据所述标准格式对所述元素所涉及的字符串进行校验。进一步地，所述错误校验模块，用于在分析出所述接口访问失败的原因后，结合所述标准格式给出修正提示。进一步地，所述错误校验模块，根据所述标准格式对所述元素所涉及的字符串进行校验时，用于根据所述标准格式采用正则表达式对所述元素所涉及的字符串进行匹配。进一步地，所述错误校验模块，根据所述标准格式对所述元素所涉及的字符串进行校验时，用于根据所述标准格式采用数据区间判断对所述交互参数所涉及的字符串进行匹配校验。进一步地，所述错误校验模块，用于在根据所述元素及与所述接口的类型相应的构造规则生成所述接口时，对所述元素中的交互参数进行校验，如果所述交互参数的输入内容出现错误，则展示错误内容并提供修正提示供修改所输入的交互参数，如果所述交互参数的输入内容正确，则通知所述接口生成模块根据所述交互参数的输入内容进行处理。进一步地，所述接口生成模块，根据所述交互参数的输入内容进行处理时，用于根据所述交互参数中的密钥信息获取应用于所述接口的数字签名。为了解决上述技术问题，本发明还公开了一种基于开放平台的接口生成校验方法，包括预先设置所述元素的标准格式；根据每种类型的接口的构造规则分别获取生成每种类型的接口所需的元素；在应用程序接入接口时提示输入与待接入接口的类型相应的元素，所述元素的输入内容与所述应用程序相关；根据所述元素及与所述接口的类型相应的构造规则生成所述接口 ；在访问所述接口失败时，根据所述标准格式对所述元素所涉及的字符串进行校验，根据校验结果分析出所述接口访问失败的因素。进一步地,所述元素,包括与所述接口相关的域名、路径和/或交互参数。进一步地，根据所述标准格式对所述元素所涉及的字符串进行校验时，依照所述元素中域名、路径、交互参数的顺序采用职责链方式完成。进一步地，在分析出所述接口访问失败的因素后，结合所述标准格式给出修正提
/Jn o 进一步地，在访问所述接口成功时，执行结果页面。进一步地，对所述元素所涉及的字符串进行校验通过以下方式实现根据所述标准格式采用正则表达式对所述元素所涉及的字符串进行匹配。进一步地，在访问所述接口失败时，还根据所述标准格式采用数据区间判断方式对所述元素所涉及的字符串进行匹配校验。进一步地，在根据所述元素及与所述接口的类型相应的构造规则生成所述接口时，还对所述元素中的交互参数进行校验，如果所述交互参数的输入内容出现错误，则展示错误内容并提供修正提示，如果所述交互参数的输入内容正确，则对所述交互参数的输入内容进行处理。进一步地，对所述元素中的交互参数进行校验，包括根据所述标准格式采用正则表达式对所述交互参数所涉及的字符串进行匹配，以及根据所述标准格式采用数据区间判断对所述交互参数所涉及的字符串进行匹配校验。进一步地,对所述交互参数的输入内容进行处理,包括当所述交互参数进一步包括密钥信息时，还根据所述密钥信息获取应用于所述接口的数字签名。与现有的方案相比，本发明所获得的技术效果I)错误校验和接口生成的组合可以贯穿在第三方开发者开始接入和接入过程中，接口生成机制保证第三方开发者生成正确接口，错误校验机制保证第三方开发者在生成了错误接口时提供简便快速的解决方案，从而确保第三方开发者开发的顺畅性和高效率。2)错误校验作为一个简便的错误响应机制，使得第三方开发者在出错时能及时得到解答，同时在一定程度上会替代技术客服的功能，进而减轻了开放平台技术客服的工作压力，可大大提升开放平台侧的工作效率，节省更多的人力。3)接口生成机制只需要第三方开发者提供元素即可自动生成接口，大大简化了人工操作的复杂程度，从而有效降低了出现错误的几率。
图I为本发明实施例的方法流程2为本发明实施例的具体实施流程图；图3为本发明实施例中接口生成机制的操作流程图；图4为本发明实施例中错误校验机制的操作流程图；图5为本发明实施例的设备的第一结构图；图6为本发明实施例的设备的第二结构图；图7为本发明实施例的设备的第三结构图。具体实施例方式以下将配合图式及实施例来详细说明本发明的实施方式，藉此对本发明如何应用技术手段来解决技术问题并达成技术功效的实现过程能充分理解并据以实施。本发明应用于开放平台，如图I所示，为本发明实施例的方法流程图，执行如下操作预先设置所述元素的标准格式(步骤SI);根据每种类型的接口的构造规则分别获取生成每种类型的接口所需的元素(步骤S2);在应用程序接入接口时提示输入与待接入接口的类型相应的元素，所述元素的输入内容与所述应用程序相关(步骤S3);再根据所述元素及与所述接口的类型相应的构造规则生成所述接口(步骤S4);在访问所述接口失败时，根据所述标准格式对所述元素所涉及的字符串进行校验，根据校验结果分析出所述接口访问失败的因素(步骤S5)。
以下以一实施例对本发明的方法进行说明。如图2所示，为本发明实施例的具体实施流程图，执行如下操作步骤SS1，预先设置所述元素的标准格式；根据每种类型的API的构造规则分别抽象出生成每种类型的API所需的元素；在应用程序接入API时提示输入与待接入API的类型相应的元素，所述元素的输入内容与所述应用程序相关；再根据所述元素及与所述API的类型相应的构造规则生成所述API ；所述元素，包括所述API的域名、路径和/或交互参数；所述路径一般在域名之后从而组成所述API的统一资源定位符(URL)。在生成所述API时,还对所述元素中的交互参数进行校验,如果所述交互参数的输入内容出现错误，则展示错误内容并提供修正提示，如果所述交互参数的输入内容正确，则根据所述交互参数的输入内容进行处理。对所述元素中的交互参数会联合使用多种校验方式来校验，因为输入的交互参数多种多样，因此会根据不同的交互参数使用对应的校验方式，包括1)根据所述标准格式采用正则表达式对所述交互参数所涉及的字符串进行匹配，例如采用基于正则表达式实现的URL验证器检测所述回调URL的格式的有效性，当然，本发明并不限于次，还可以使用正则表达式校验金额、权限等；2)还可以根据所述标准格式采用数据区间判断(如判断字符串的总体长度是否处于区间内、字符串的值是否处于数据区间等等)对所述交互参数所涉及的字符串进行匹配校验。当然，本发明并不限于以上两者，还可以使用其他方式。根据所述交互参数的输入内容进行处理的操作，包括当所述交互参数进一步包括密钥信息时，还根据所述密钥信息获取应用于所述API的数字签名；当然还可以包括其他的操作，本发明并不仅限于此。以下以生成用于充值的API为例来说明步骤SSl的接口生成机制。用于充值的API 的 URL 为 https://openapi.360.cn/page/pay,其中openapi. 360. cn即为所述API的域名，page/pay即为所述API的路径，需要输入的交互参数如下表所示
权利要求
1.一种基于开放平台的接口生成校验设备，其特征在于，包括设置模块、配置模块、提示模块、接口生成模块和错误校验模块，其中， 所述设置模块，用于预先设置所述元素的标准格式； 所述配置模块，用于根据每种类型的接口的构造规则分别获取生成每种类型的接口所需的元素； 所述提示模块，用于在应用程序接入接口时提示输入与待接入接口的类型相应的元素，所接收到的元素的输入内容与所述应用程序相关； 所述接口生成模块，用于根据所述元素及与所述接口的类型相应的构造规则生成所述接口 ； 所述错误校验模块，用于在访问所述接口失败时，根据所述标准格式对所述元素所涉及的字符串进行校验，根据校验结果分析出所述接口访问失败的因素。
2.如权利要求I所述的基于开放平台的接口生成校验设备，其特征在于， 所述元素，包括与所述接口相关的域名、路径和/或交互参数。
3.如权利要求I或2所述的基于开放平台的接口生成校验设备，其特征在于， 所述错误校验模块，进一步用于依照所述元素中域名、路径、交互参数的顺序采用职责链方式，根据所述标准格式对所述元素所涉及的字符串进行校验。
4.如权利要求1-3中任一项所述的基于开放平台的接口生成校验设备，其特征在于， 所述错误校验模块，进一步用于在分析出所述接口访问失败的原因后，结合所述标准格式给出修正提示。
5.如权利要求1-4中任一项所述的基于开放平台的接口生成校验设备，其特征在于， 所述错误校验模块，根据所述标准格式对所述元素所涉及的字符串进行校验时，进一步用于根据所述标准格式采用正则表达式对所述元素所涉及的字符串进行匹配。
6.如权利要求1-5中任一项所述的基于开放平台的接口生成校验设备，其特征在于， 所述错误校验模块，根据所述标准格式对所述元素所涉及的字符串进行校验时，进一步用于根据所述标准格式采用数据区间判断对所述交互参数所涉及的字符串进行匹配校验。
7.如权利要求1-6中任一项所述的基于开放平台的接口生成校验设备，其特征在于， 所述错误校验模块，用于在根据所述元素及与所述接口的类型相应的构造规则生成所述接口时，对所述元素中的交互参数进行校验，如果所述交互参数的输入内容出现错误，则展示错误内容并提供修正提示供修改所输入的交互参数，如果所述交互参数的输入内容正确，则通知所述接口生成模块根据所述交互参数的输入内容进行处理。
8.如权利要求1-7中任一项所述的基于开放平台的接口生成校验设备，其特征在于， 所述接口生成模块，根据所述交互参数的输入内容进行处理时，用于根据所述交互参数中的密钥信息获取应用于所述接口的数字签名。
9.一种基于开放平台的接口生成校验方法，其特征在于，包括 预先设置所述元素的标准格式； 根据每种类型的接口的构造规则分别获取生成每种类型的接口所需的元素； 在应用程序接入接口时提示输入与待接入接口的类型相应的元素，所述元素的输入内容与所述应用程序相关；根据所述元素及与所述接口的类型相应的构造规则生成所述接口； 在访问所述接口失败时，根据所述标准格式对所述元素所涉及的字符串进行校验，根据校验结果分析出所述接口访问失败的因素。
10.如权利要求9所述的基于开放平台的接口生成校验方法，其特征在于， 所述元素，包括与所述接口相关的域名、路径和/或交互参数。
11.如权利要求9或10所述的基于开放平台的接口生成校验方法，其特征在于， 根据所述标准格式对所述元素所涉及的字符串进行校验时，依照所述元素中域名、路径、交互参数的顺序采用职责链方式完成。
12.如权利要求9-11中任一项所述的基于开放平台的接口生成校验方法，其特征在于， 在分析出所述接口访问失败的因素后，结合所述标准格式给出修正提示。
13.如权利要求9-12中任一项所述的基于开放平台的接口生成校验方法，其特征在于， 在访问所述接口成功时，执行结果页面。
14.如权利要求9-13中任一项所述的基于开放平台的接口生成校验方法，其特征在于，对所述元素所涉及的字符串进行校验通过以下方式实现 根据所述标准格式采用正则表达式对所述元素所涉及的字符串进行匹配。
15.如权利要求9-14中任一项所述的基于开放平台的接口生成校验方法，其特征在于， 在访问所述接口失败时，还根据所述标准格式采用数据区间判断方式对所述元素所涉及的字符串进行匹配校验。
16.如权利要求9-15中任一项所述的基于开放平台的接口生成校验方法，其特征在于， 在根据所述元素及与所述接口的类型相应的构造规则生成所述接口时，还对所述元素中的交互参数进行校验，如果所述交互参数的输入内容出现错误，则展示错误内容并提供修正提示，如果所述交互参数的输入内容正确，则对所述交互参数的输入内容进行处理。
17.如权利要求9-16中任一项所述的基于开放平台的接口生成校验方法，其特征在于，对所述元素中的交互参数进行校验，进一步包括 根据所述标准格式采用正则表达式对所述交互参数所涉及的字符串进行匹配，以及根据所述标准格式采用数据区间判断对所述交互参数所涉及的字符串进行匹配校验。
18.如权利要求9-17中任一项所述的基于开放平台的接口生成校验方法，其特征在于，对所述交互参数的输入内容进行处理，进一步包括 当所述交互参数进一步包括密钥信息时，还根据所述密钥信息获取应用于所述接口的数字签名。
全文摘要
本发明公开了基于开放平台的接口生成校验方法及设备，其中所述设备，包括设置模块，预先设置所述元素的标准格式；配置模块，根据每种类型的接口的构造规则分别获取生成每种类型的接口所需的元素；提示模块，在应用程序接入接口时提示输入与待接入接口的类型相应的元素，所接收到的元素的输入内容与所述应用程序相关；接口生成模块，根据所述元素及与所述接口的类型相应的构造规则生成所述接口；错误校验模块，在访问所述接口失败时，根据所述标准格式对所述元素所涉及的字符串进行校验，根据校验结果分析出所述接口访问失败的因素。本发明嫩够保证第三方开发者生成正确接口，并在第三方开发者在生成了错误接口时提供简便快速的解决方案。
文档编号G06F9/44GK102707958SQ20121018974
公开日2012年10月3日 申请日期2012年6月8日 优先权日2012年6月8日
发明者胡聪 申请人:奇智软件(北京)有限公司