REST in Pieces: RESTful Design Rule Violations in Student-Built Web Apps

2025-07-15

AI Summary

This study addresses the insufficient training in software quality—particularly REST API design—in undergraduate computer science education. We systematically evaluated REST conformance across 40 full-stack projects developed by third-year students in a Web Technologies course. Leveraging a novel automated static analysis pipeline, we quantitatively assessed violations against authoritative RESTful design principles across critical dimensions, including URI naming conventions and HTTP method usage. Results reveal widespread deviations: 98% of API endpoints omit hyphens in path segments; 88% misuse resource nouns (e.g., incorrect singular/plural forms); and 83% employ inappropriate HTTP verbs. To our knowledge, this work establishes the first empirical benchmark for undergraduate API design proficiency, uncovering critical pedagogical gaps. Moreover, it provides foundational data and methodology to support the development of education-oriented automated feedback tools for API design instruction.

Technology Category

• Application Domains: Software Engineering
• Knowledge Representation and Reasoning: Automated Reasoning and Theorem Proving
• Constraint Satisfaction and Optimization: Satisfiability Modulo Theories

Application Category

• Systems and Infrastructure for Web, Mobile and WoT: Web performance, measurement, and characterization
• Graph Algorithms and Modeling for the Web: Efficient manipulation of static and dynamic Web-related graphs
• Search and Retrieval-Augmented AI: Web evaluation methodologies and metrics

Abstract

In Computer Science Bachelor's programs, software quality is often underemphasized due to limited time and a focus on foundational skills, leaving many students unprepared for industry expectations. To better understand the typical quality of student code and inform both education and hiring practices, we analyze 40 full-stack web applications developed in a third-year Web Technologies course. Using an automated static analysis pipeline, we assess adherence to REST API design rules. Results reveal frequent violations of foundational conventions, such as missing hyphens in endpoint paths (98%), incorrect pluralization (88%), and misuse of HTTP methods (83%). These findings highlight the need for more focused instruction on API design and support the adoption of automated tools to improve code quality in student projects.

Problem

• Analyzes REST API design violations in student web apps
• Identifies common errors like incorrect HTTP methods
• Highlights need for better API design education

Innovation

• Automated static analysis pipeline
• Assessing REST API design rules
• Identifying frequent convention violations