Where academic tradition
meets the exciting future

Designing Level 3 Behavioral RESTful Web Service Interfaces

Irum Rauf, Ivan Porres, Designing Level 3 Behavioral RESTful Web Service Interfaces. Applied Computing Review 11 , 19–31, 2011.


A web service interface contains information about the names of the operations that can be invoked on the service and the input and output parameters of these operations. This information is not enough to facilitate service developer and consumer in understanding the behavior of the service. In the context of RESTful web services, the requirements of RESTful interface should also be met that are not fulfilled by just advertising the allowed operations on the resources. In addition, RESTful services take hypermedia as an engine of application states. Such services are defined to be at level 3 of Richardson Maturity Model(RMM). In this paper, we present an approach to model the structural and behavioral interface of a RESTful web service using UML class and UML protocol diagrams. These models lead to RESTful interfaces that conform to level 3 of RMM and describe the behavior of operations in terms of preconditions and post-conditions. These models facilitate the authentication mechanism and provide clear mapping to HTTP requests and responses. The generated contracts of methods can be published in an extended version of the WADL language and also used for documentation, stub generation, testing and monitoring purposes.

BibTeX entry:

  title = {Designing Level 3 Behavioral RESTful Web Service Interfaces},
  author = {Rauf, Irum and Porres, Ivan},
  journal = {Applied Computing Review},
  volume = {11 },
  publisher = {ACM New York, NY, USA},
  pages = {19–31},
  year = {2011},
  keywords = {Design, Web Service, Interface, REST, Behavioral Interface},

Belongs to TUCS Research Unit(s): Software Engineering Laboratory (SE Lab)

Publication Forum rating of this publication: level 1

Edit publication