Skip to main content
zenodoopen

Do Design Rules Have an Impact on the Understandability of RESTful APIs? A Web-Based Experiment with API Descriptions

<p>This repository contains materials of a controlled experiment with 105 participants that studied the impact of design rules on the understandability of RESTful APIs.</p> <p>The following materials are provided:</p> <ul> <li>The data set (<code>results.csv</code>) with a description (<code>data-set-description.md</code>)</li> <li>The cleaning protocol (<code>data-cleaning-protocol.md</code>)</li> <li>The R analysis script (<code>analysis.R</code>)</li> <li>The two OpenAPI documents used as the foundation for the experiment <ul> <li>Adhering to the rules:&nbsp;<code>openapi-rules.yaml</code></li> <li>Violating the rules:&nbsp;<code>openapi-violations.yaml</code></li> </ul> </li> </ul>

ShareScore

32/100

Overall dataset sharing score

Score breakdown

These five areas show where the dataset supports — or may limit — practical reuse.

Stewardship
4
Harmonization
4
Access
16
Reuse readiness
8
Engagement
0