[发明专利]一种RESTful API可视化方法

摘要

本发明公开了一种API可视化的方法。API可视化，使得API更加直观和易懂，并且开发者可以定义和修改成所需的API结构，重新发布自己API服务，以供其他开发者使用。本发明可以支持程序读取API描述文件，程序根据描述文件自动传递参数，简化了API开发者的工作，API结构更加直观和易读，更加容易被非专业的开发者接受。本发明中的自动生成API输出结构，可有效地减少了开发者设计API输出结构的工作，使得整个API结构可以半自动化生成。

主权项

1.一种RESTful API可视化方法，基于API调用实例的返回数据，可视化展示API，具体包括如下步骤：1、分析API的输入结构和具体用途，构造输入用例；2、执行步骤1中所述输入用例，得到返回数据，所述返回数据包括如下两类：a.服务器返回有效数据；b.服务器返回无效数据；3、若步骤2中返回的是无效数据，提示返回无效数据；若返回的是有效数据，则解析有效数据，将其转化为模型数据；4、使用自动布局算法，将所述模型数据按照算法可视化展现，具体包括如下步骤：4.1定义ApiModel数据模型，用于描述API的功能用途及其它基本信息；定义InputModel数据模型，用于表示API的输入结构根节点；定义OutputModel数据模型，用于表示API的输出结构根节点；4.2将所述InputModel、ApiModel、OutputModel按照从左到右的顺序，即横坐标从小变大，但纵坐标相等的顺序摆放；4.3递归生成InputModel子树所有子模型坐标；从右向左顺序摆放元素，每个子节点与父节点的坐标差值为常量(‑dx,dy)；4.4递归生成OutputModel子树所有子模型坐标；从左到右顺序摆放元素，每个子节点与父节点坐标差值为常量(dx,dy)。