Do Design Rules Have an Impact on the Understandability of RESTful APIs? A Web-Based Experiment with API Descriptions
收藏资源简介:
This repository contains materials of a controlled experiment with 105 participants that studied the impact of design rules on the understandability of RESTful APIs. The following materials are provided: The data set (<code>results.csv</code>) with a description (<code>data-set-description.md</code>) The cleaning protocol (<code>data-cleaning-protocol.md</code>) The R analysis script (<code>analysis.R</code>) The two OpenAPI documents used as the foundation for the experiment Adhering to the rules: <code>openapi-rules.yaml</code> Violating the rules: <code>openapi-violations.yaml</code>
本仓库收录了一项针对105名参与者的对照实验相关材料,该实验旨在研究设计规则对RESTful应用程序编程接口(RESTful APIs)可理解性的影响。本次提供的材料包括:附带说明文档(data-set-description.md)的数据集(results.csv)、数据清理协议文档(data-cleaning-protocol.md)、R语言分析脚本(analysis.R),以及两份作为实验基础的开放API(OpenAPI)文档:遵循设计规则的openapi-rules.yaml与违反设计规则的openapi-violations.yaml。



