[发明专利]一种基于开放平台的接口生成校验方法及设备

说明书

技术领域

本发明属于计算机领域，具体地说，涉及一种基于开放平台的接口生成校验方法及设备。

背景技术

在现有的互联网时代，将网站的服务封装成一系列计算机易识别的API（应用编程接口）开放出去，提供给第三方开发者使用，这种行为叫做Open API，提供Open API的平台被称为开放平台。第三方开发者，即已经提供互联网应用程序或即将提供互联网应用程序的个人与单位，想将自有的应用程序放置在开放平台上，进而提供给最终用户。最终用户，即使用开放平台所提供的应用程序的群体。

具有Open API的网站不仅能提供对网页的简单访问，还可以进行复杂的数据交互等其他操作，所述网站从而转换为与操作系统等价的开发平台，第三方开发者可以基于这些已经存在的且公开的网站而开发许多丰富多彩的应用。在众多的互联网开放平台中，依据所服务的主体不同，也将开放平台分为两类，一类是中心化开放平台，平台的Open API主要用于针对自身的网站提供所开发的应用程序的业务功能，所述应用程序接入这些API从而集成相应的功能，在开放平台上展现提供服务；还有一种是分布式开放平台，这类平台提供一个标准API并串联第三方开发者使用所述标准API开发应用程序，在审核所述应用程序的安全性和稳定性之后，即可将这些应用程序推向所有支持该标准API的网站。

第三方开发者将应用程序接入开放平台的某项功能（即相应的Open API）时，需要根据自身业务需求和开放平台的相关引导选择合适的接入流程，并在接入流程中需要理解具有相关性的多个Open API定义，对于Open API的使用是第三方开发者接入开放平台的主要工作之一。一般情况下，开放平台会为第三方开发者提供详尽的Open API说明文档和接入教程以指导其将应用程序接入开放平台的相应功能，但是开发者对接入流程以及Open API定义的不熟悉，不可避免地会导致在应用程序接入相应功能时生成错误的API从而导致接入开放平台失败，错误类型包括：API路径错误、API涉及的域名错误、API相关元素错误等。

现阶段，第三方开发者将应用程序接入开放平台的某项功能时需要按照Open API说明文档和接入教程编写生成相应API。如果所述API的编写符合规则要求，访问所述API会直接开启对应的页面。但是当所述API的生成存在错误时，如果是前端访问所述API，一般会在页面上给出错误码或错误描述，如果是后端访问所述API，会直接返回错误码或错误描述。在第三方开发者拿到错误码或错误描述后，联系相关运营人员或者技术客服进行咨询，然后根据所得到的咨询结果进行修改并重新生成API然后再进行访问。有可能依然存在错误修改再次咨询后修改，这个过程可能需要经过几轮反复最终才能使应用程序成功接入API。

显然，在接入API的过程中，生成API过程的复杂直接导致出现错误的情况较多，而开发者在遇到问题时又缺乏相关错误的处理经验，而且受前端展示方式所限，第三方开发者很难得到错误的详尽的信息。

而在获取到错误信息之后，现有流程中缺乏快速简便的错误分析工具，而只采取人工交互的行为进行一对一讲解，人工咨询的解决方式会大大降低开发者的开发效率；而且在大量的问题反馈到技术客服时，也会增加开放平台技术客服的工作量。

发明内容

有鉴于此，本发明所要解决的技术问题是提供了一种基于开放平台的接口生成校验方法及设备，错误校验和接口生成的组合可以贯穿在第三方开发者开始接入和接入过程中，接口生成机制保证第三方开发者生成正确接口，错误校验机制保证第三方开发者在生成了错误接口时提供简便快速的解决方案，从而确保第三方开发者开发的顺畅性，也减轻了开放平台技术客服的工作压力。

为了解决上述技术问题，本发明公开了一种基于开放平台的接口生成校验设备，包括：设置模块、配置模块、提示模块、接口生成模块和错误校验模块，其中，所述设置模块，用于预先设置所述元素的标准格式；所述配置模块，用于根据每种类型的接口的构造规则分别获取生成每种类型的接口所需的元素；所述提示模块，用于在应用程序接入接口时提示输入与待接入接口的类型相应的元素，所接收到的元素的输入内容与所述应用程序相关；所述接口生成模块，用于根据所述元素及与所述接口的类型相应的构造规则生成所述接口；所述错误校验模块，用于在访问所述接口失败时，根据所述标准格式对所述元素所涉及的字符串进行校验，根据校验结果分析出所述接口访问失败的因素。

进一步地，所述元素，包括：与所述接口相关的域名、路径和/或交互参数。