This Article 
   
 Share 
   
 Bibliographic References 
   
 Add to: 
 
Digg
Furl
Spurl
Blink
Simpy
Google
Del.icio.us
Y!MyWeb
 
 Search 
   
Welcome to the Real World: A Notation for Modeling REST Services
July-Aug. 2012 (vol. 16 no. 4)
pp. 36-44
Olga Liskin, Leibniz Universit ät Hanover
Leif Singer, Leibniz Universit ät Hanover
Kurt Schneider, Leibniz Universität Hanover
Documentation of REST and REST-style services often uses prose only, making it hard for client developers to understand the ties between the service's parts. We developed a notation for REST-style services that's based on UML state charts. It can be used with existing tools and is simple enough for use on whiteboards. The notation visualizes relationships between application states, thereby improving the understanding of hypermedia use in services. This benefits both service designers and client developers. Because the notation makes REST-related design problems more obvious, it might even improve service design.

1. R.T. Fielding, "Architectural Styles and the Design of Network-Based Software Architectures," doctoral dissertation, Univ. of California, Irvine, 2000.
2. J. Webber, S. Parastatidis, and I. Robinson, REST in Practice: Hypermedia and Systems Architecture, O'Reilly Media, 2010.
3. J. Algermissen, "Classification of HTTP-Based APIs," 2010; http://nordsc.com/extclassification_of_http_based_apis.html .
4. Z. Maamar, B. Benatallah, and W. Mansoor, "Service Chart Diagrams — Description & Application," Proc. Alternate Tracks of the 12th Int'l World Wide Web Conf. (WWW 2003), ACM, 2003; www.www2003.org/cdrom/papers/alternate/P043 p43-maamar.pdf.
5. P. Dolog and J. Stage, "Designing Interaction Spaces for Rich Internet Applications with UML," Proc. Int'l Conf. Web Eng. (ICWE 2007), LNCS 4607, Springer, 2007, pp. 358–363.
6. A. Umar, Object-Oriented Client/Server Internet Environments, Prentice Hall Press, 1997.
7. M. Nottingham, Web Linking, IETF RFC 5988, 2010; http://tools.ietf.org/htmlrfc5988.
8. O. Liskin, L. Singer, and K. Schneider, "Teaching Old Services New Tricks: Adding HATEOAS Support as an Afterthought," Proc. Int'l Workshop on RESTful Design (WS-REST 11), ACM, 2011, pp. 3–10.
9. L. Richardson and S. Ruby, RESTful Web Services, O'Reilly Media, 2007.
10. S. Tilkov, REST und HTTP: Einsatz der Architektur des Web für Integrationsszenarien [REST and HTTP: Application of the Web's Architecture for Integration Scenarios], 9th ed., dpunkt Verlag, 2009.

Index Terms:
Unified modeling language,Documentation,Computer architecture,Protocols,Servers,Web services,service documentation,Unified modeling language,Documentation,Computer architecture,Protocols,Servers,Web services,design notations,RESTful Web services,service design
Citation:
Olga Liskin, Leif Singer, Kurt Schneider, "Welcome to the Real World: A Notation for Modeling REST Services," IEEE Internet Computing, vol. 16, no. 4, pp. 36-44, July-Aug. 2012, doi:10.1109/MIC.2012.59
Usage of this product signifies your acceptance of the Terms of Use.