[发明专利]一种轻量级API Server开发框架及开发方法

说明书

本发明公开了一种轻量级API Server开发框架以及轻量级API Server开发方法，包括Server子系统、Client子系统和API子系统，其中API子系统用于定义API Server所支持的API集合，Server子系统包括有API实现类库，其包括有用于定义API业务逻辑的API实现类，在开发过程中，对于每一API，只需在API子系统添加上一对API请求类和API响应类，并根据实际业务需要，在API实现类库中添加对应的API实现类即可，使得开发人员可以专注在API的编程上，极大减少了编程的代码量，提高了开发效率。

技术领域

本发明涉及API Server开发技术领域，尤其涉及一种轻量级API Server开发框架以及轻量级API Server开发方法。

背景技术

在互联网的IT公司中，常常涉及到开发大型的内部业务系统，其中一个大的系统由若干分布式部署的子系统组成，不同的子系统之间需要通过公开接口进行内部网络的通信。在这种情况下，为了提高接口模块的开发效率，降低开发、部署、运维成本，本申请发明人提出了一种轻量级API Server开发框架及开发方法。

发明内容

为了克服现有技术的不足，本发明的目的在于提供一种轻量级API Server开发框架，能够提高API Server的开发效率。本发明的目的之二在于提供一种轻量级API Server开发方法，能够提高API Server的开发效率。

本发明的轻量级API Server开发框架，采用如下技术方案实现：

一种轻量级API Server开发框架，包括：

API子系统，其用于定义所述API Server所支持的API集合；

Server子系统，其用于提供对外的API服务；

Client子系统，其用于调用所述Server子系统提供的API服务；

所述API集合中的每一API由三部分定义，分别为API标识、一个API请求类和一个API响应类，所述API标识用于区分不同的API，所述API请求类用于定义API的请求参数，所述API响应类用于定义API的响应参数；

所述Server子系统包括API实现类库、管理器和控制器；所述控制器用于向所述管理器传递API的请求数据以及用于向所述Client子系统传递API的响应数据；所述管理器用于根据接收到的API的请求数据，调用API实现类库中对应的API实现类，以得到API的响应数据，并将响应数据返回给控制器。

进一步地，所述Server子系统和所述Client子系统之间采用HTTP协议实现通信。

进一步地，所述Server子系统，其采用Jetty容器作为WEB容器。

进一步地，所述Client子系统调用API服务时，采用GET方式将API的请求参数以URL参数的方式提交给所述Server子系统。

进一步地，所述轻量级API Server开发框架还包括异常处理模块，所述异常处理模块通过HTTP Status Code携带异常信息。

进一步地，所述Server子系统还包括配置读取模块和配置文件，所述配置读取模块用于读取配置文件的配置信息，并将配置信息转发给所述管理器；所述管理器还用于根据接收到的配置信息，加载对应的API实现类，以获取该API实现类对应的API标识，并将该API标识更新至服务注册表。

本发明的轻量级API Server开发方法，采用如下技术方案实现：

一种轻量级API Server开发方法，应用上述的轻量级API Server开发框架，所述开发方法包括：

根据业务需求确定所述API Server的API集合；