Shapir：标准化和民主化 Web API 访问

文献标题

Shapir: Standardizing and Democratizing Access to Web APIs

文献信息

• 主题领域: Web API的标准化与民主化访问
• 关键词: Web APIs, API Description Languages, Schema.org, Semantic Web, API Integration, Programming Interfaces, Data Interoperability, Mavo, ShapirJS, WoOPI

研究背景与问题

• 问题或挑战:
  1. 当前每个网站的Web API语法和数据模型都不统一，且需要用户手动编写复杂的HTTP请求、处理分页、认证等。
  2. 开发者需要花费大量时间阅读文档、学习每个API，而且对于非专业用户而言难度较高。
  3. API之间缺乏统一的标准化模型，这限制了跨网站的数据整合和复用。
• 重要性:
  • 标准化和简化API访问能够大幅降低开发工作量，使得更多用户能够重复使用多网站的数据，提高开发效率。
• 研究动机与相关工作:
  • 作者基于Schema.org和现有的API描述方法（如OpenAPI、Swagger），希望开发一个统一的API标准和工具，克服现有方法在描述数据模型和关联上的局限性。

解决方案

• 方法或解决方案:
  1. 提出“Web of Objects Programming Interface (WoOPI)”：
     • 提供一种标准化的API描述语言，基于Schema.org构建，能够描述API所管理的对象、属性、方法及其相互关系。
  2. 开发“ShapirJS”:
     • 用于将Web API数据包装为本地可操作的JavaScript对象，简化API调用。
  3. 提供“ShapirUI”:
     • 一个可视化工具，允许用户通过图形界面为API生成WoOPI描述。
  4. 与“Mavo”集成:
     • 使非开发者可通过撰写HTML创建交互式、基于API的数据管理应用。
• 创新之处:
  • 基于Schema.org标准映射API数据模型，实现跨多个API的数据统一操作。
  • 提供无需编程的图形化工具（ShapirUI）创建WoOPI描述，降低了技术门槛。
  • 与Mavo无缝结合，非开发者仅需HTML即可操作API数据。
• 实施步骤与技术:
  1. WoOPI通过分析现有API习惯（如CRUD方法）生成标准化的对象-方法模型。
  2. ShapirJS根据WoOPI模型动态生成JavaScript API库，自动处理分页、认证与异步操作。
  3. ShapirUI结合语义分析与智能匹配，辅助用户将站点API映射到Schema.org类型。
  4. 与Mavo结合，通过标准属性和方法支持简单的HTML为基础的API操作。

研究成果

• 具体成果:
  1. 设计了WoOPI描述语言，可用于描述大约90%的现有Web API。
  2. 开发了ShapirJS库和ShapirUI工具，并成功实现与Mavo的集成。
  3. ShapirJS支持以标准对象类型（如VideoObject）统一管理跨站点数据，同时自动完成所需API调用。
• 优势:
  1. 在开发速度上，ShapirJS使得程序员完成涉及多API的任务快了约5.6倍（与Swagger对比）。
  2. 使用ShapirJS和Mavo的非程序员可在数分钟内完成数据管理应用，降低技术门槛。
  3. 工具链模块化设计，支持未来替换和扩展。
• 实验和评估:
  • 编程者使用ShapirJS进行API任务的时间显著少于传统方法（如Swagger）。
  • 非编程者仅4分钟即可用Mavo与ShapirUI完成跨API应用搭建。
  • 通过用户研究表明工具易用性高，非技术背景的用户也能快速参与。
• 局限性与未来方向:
  1. Schema.org的属性表示过于宽泛（单复数和类型不一致），未来需要更强的验证机制。
  2. 目前只实现了读取API数据的能力，将来应扩展支持写操作。
  3. 网站API与Schema.org标准类型的映射目前难以统一，可探索自动化或社区协作的方式改进一致性。
  4. 数据跨网站操作上的限制（如不能将一站点数据存储在另一站点内）。

通过此研究，Shapir及其生态系统为Web API数据访问和集成带来了变革性简化，同时促进了标准化互操作工具的创建和实践。