Inter-parameter Constraints in Contemporary Web APIs

Today’s web applications often rely on a myriad of external web APIs, communicating with them through various HTTP requests spread throughout the application. These APIs are often textually described by constraints on the inputs and outputs of their entry points. In this paper we discuss constraints in web APIs that span multiple parameters. We show that these constraints are common in web APIs, but cannot be expressed in existing machine-readable API specification languages. We envision the emergence of constraint-centric specification languages which focus on expressing constraints and describe a prototypical language that supports constraints over multiple parameters.

[1]  Sukyoung Ryu,et al.  SAFEWAPI: web API misuse detector for web applications , 2014, SIGSOFT FSE.

[2]  Tomas Vitvar,et al.  hRESTS: An HTML Microformat for Describing RESTful Web Services , 2008, 2008 IEEE/WIC/ACM International Conference on Web Intelligence and Intelligent Agent Technology.

[3]  Peter J. Danielsen,et al.  Validation and Interactivity of Web API Documentation , 2013, 2013 IEEE 20th International Conference on Web Services.

[4]  Rik Van de Walle,et al.  Survey of Semantic Description of REST APIs , 2014 .

[5]  Marc J. Hadley,et al.  Web application description language (WADL) , 2006 .

[6]  I. Melzer Web Services Description Language , 2010 .