There is a newer version of the record available.

Published May 9, 2023 | Version v2

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

  • 1. University of Stuttgart
  • 2. University of Applied Sciences Reutlingen

Description

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 (results.csv) with a description (data-set-description.md)
  • The cleaning protocol (data-cleaning-protocol.md)
  • The R analysis script (analysis.R)
  • The two OpenAPI documents used as the foundation for the experiment
    • Adhering to the rules: openapi-rules.yaml
    • Violating the rules: openapi-violations.yaml

Files

rest-api-experiment.zip

Files (20.4 kB)

Name Size Download all
md5:51e478838ed1a5a4d815a415db766ad8
20.4 kB Preview Download