Web接口规范化管理设计与实现

2018-11-05叶刚

电子技术与软件工程 2018年18期

叶刚

摘要： Web接口统一化管理与设计介绍了如何规范化的、高效的管理诸多类型的接口。本文的设计适用于对外提供数据接口的管理类型系统，它从数据接口的类型：静态数据源、数据库数据源、本地方法以及第三方API，请求方式，接口返回的数据格式，接口访问入口地址唯一，可视化管理，接口日志管理，静态数据源管理，数据库配置管理等方面对其进行设计。

【关键词】管理系统接口规范化

1 引言

接口指外部应用获取系统数据时，系统为其提供自己允许访问的入口（请求路径），称为接口。随着近年来前后端分离，Web接口开发变得愈发重要了。以前对于一些管理系统，其是对数据进行管理为主，大多都是一些增加，修改，删除，查询简单操作，页面简单，由后端开发人员完成页面与后台业务的开发是绰绰有余的。随着前端页面越来越复杂化，页面需要设计与前端人员开发，此时后端人员无法完成这么复杂的页面开发，需要专人完成前端开发，后端只需提供Web接口。Web接口的运用场景有很多如：前端页面调用（如：大屏、官网等），移动终端调用，不同系统之间的调用。

2 接口类型概念

管理系统对外提供的Web接口类型多种多样，便于规范化的管理，根据数据源类型做出以下分类：

2.1 静态数据源接口

管理系统可能会对外提供一些静态数据，用来实现某些实例，比如提供仪表盘图表的demo数据{”series”：[{”name”：”业务指标”，”type”：”gauge”，”data”：[{”value”： 50，”name”：”完成率”）]}】），这种常量类型接口称之为静态数据源接口；

2.2 数据库接口

有些业务需求比较简单基本没有逻辑上得处理，可以直接通过数据库查询获取接口数据，这种类的接口为数据库接口；

2.3 本地方法接口

有些业务接口比较逻辑比较繁杂，通过简单的数据库接口无法实现，需要后台提供一个接口方法做逻辑处理后返回数据，这类接口称之为本地方法接口。

2.4 第三方API接口

有些接口本可以直接由第三方提供（如：天气接口），亦可以被直接调用，但是便于统一化管理，这类通过后台管理的第三方的接口在此称为第三方API接口。

3 规范化设计

在开发移动终端或复杂的前端页面时，我们可能需要设计大量的Web接口，这些接口的类型可能多种多样，同时根据功能的不同接口的功能类型亦可以是多种多样，需求的不同接口返回的数据格式也可能不同，太多的不同接口文档的编写存在一定的困难.接口修改时文档的即时更新也是存在的问题。针对此，提出对Web接口的规范化与可视化设计：

（1）对于接口量比较大的管理，通过文档实现对其管理是远远不够的，我们针对接口的共性将其数据化管理，每个接口转化成一条数据记录存于关系表中。同时设置备注属性，备注每个接口的使用方以及法使用场景。按照接口类型，接口功能类型设置接口的相关属性，按照功能设置接口名称。一个个接口转化成数据库中的一条条记录，接口的可视化转变为常见的关系表的可视化。

（2）针对接口不同类型的返回数据全部转化为JSON格式的数据，实现接口返回数据时的规范化。

（3）只对外提供一个访问入口，访问各个接口根据数据库记录以参数的形式获取每个接口的属性，从而调用相应接口，减少接口暴露过多的在系统外，保证提供接口的系统安全。

（4）接口的调用情况生成日志，存于数据库中，对其数据管理，通过对接口日志管理，为接口的使用情况有据可查。

（5）对于静态数据源数据进行管理，规范化静态数据格式（JSON格式），以便静态接口调用的静态数据的查找与修改。

（6）连接数据库的配置进行管理，达到多数据源的数据库接口均能实现调用。

4 接口规范化实现

基于规范化设计，通过数据库管理接口，接口日志，静态数据，数据库配置等，在管理系统中对其可视化管理。最后通过参数形式调用接口，使得访问接口的入口唯一。以下为接口调用的主要代码：

if（dataInterface.getlnterfaceSource（）==2）{

//第三方api

json= getDataApi（datalnterface，objectld，page）；

}else if（datalnterfacegetInrerfaceSource（）==4）{

∥本地方法