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

说明书

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

技术领域

本发明涉及服务计算领域，服务组合基于RESTful架构的技术领域，具体涉及一种RESTful API可视化方法。

背景技术

现有很多对外提供服务的网站，如百度API store、聚合数据、API Cloud、leanCloud等等，这些服务提供商的网站都是基于RESTful架构。从Web开发技术的发展过程来看，Web从最初的主要支持静态页面，到后来越来越支持动态页面。静态页面为主典型代表有门户网站、电子商务网站、搜索引擎、社交网站，到后来交互性强的多人在线的网页游戏。Rest是Roy Fielding在他2000年的博士学位论文中提出的一种新的网站架构。REST本意是“Representational State Transfer”，意思是表述性转移的缩写。所有网站符合REST设计风格都称为RESTful。分布式应用架构是REST非常成功的例子。

REST风格中有以下六个关键词：

1.资源（Resource）

资源是一种对服务器抽象的概念。将服务器看成由很多离散的资源组成，每个资源是服务器上一个可命名的抽象概念。一个资源可以由特定url来表示，客户端可以通过url来访问对应资源。

2.资源表述

资源表述表示某个资源某段时间内的状态表述。主要用于服务器和客户端进行数据交换。资源的表述可以有多种方式，以下几个比较常见的，如HTML/XML/JSON/TXT/PNG等等。

3.状态转移

指客户端与服务器端之间转移代表资源状态表述。客户端以HTTP方式请求服务器上的资源，对资源进行操作，比如添加资源、修改资源、删除资源。

4.统一接口

客户端通过HTTP协议来访问服务器。正好HTTP的几个方法对应服务器资源的操作，GET方法表示获取资源，POST方法表示新建资源，DELETE方法表示删除资源，PUT表示更新资源。

5.超文本驱动

超文本驱动的全称为“将超媒体作为应用状态的引擎”。将Web应用看成一个很多状态组成的状态机。在应用中，不仅包含资源，还包含对资源操作的状态转移语义。

基于RESTful架构的网站，其对外提供的服务，可以统称为RESTfulAPI。下文出现API都是指的RESTful API。RESTful架构通常是，客户端以HTTP或HTTPS方式对服务器发起请求，服务器返回数据格式一般是JSON类型。开发者通过阅读相关的文档来使用API。但是每个服务提供商的API文档格式千奇百怪，有些文档并不够完善。甚至有时候API已经改变了，但没有及时更新文档也是常见问题。文档作为开发者唯一交流方式有很多弊端，并且不够直观易懂。

发明内容

针对上述的遇到的问题，本发明了一种RESTful API可视化方法，使API更加直观并且易懂。本发明基于API调用实例的返回数据，可视化展示API。

具体的，本发明的采用了如下技术方案：

一种RESTful API可视化方法，基于API调用实例的返回数据，可视化展示API，具体包括如下步骤：

1、分析API的输入结构和具体用途，构造输入用例；