research-article

Designing level 3 behavioral RESTful web service interfaces

Authors:

Ivan PorresAuthors Info & Claims

ACM SIGAPP Applied Computing Review, Volume 11, Issue 3

Pages 19 - 31

https://doi.org/10.1145/2034594.2034596

Published: 01 August 2011 Publication History

Abstract

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.

References

[1]

S. Allamarajun. RESTful Web Services Cookbook. O'Reilly Media, 2010.

[2]

A. Bertolino and A. Polini. The audition framework for testing web services interoperability. Proceedings of 31th Euromicro Conference on Software Engineering and advanced Applications, pages 134--142, 2005.

Digital Library

[3]

M. Bravetti and G. Zavattaro. A Theory of Strong Service Compliance. Proceedings of the 9th international conference on Coordination models and languages, pages 96--112, 2007.

Digital Library

[4]

M. Bravetti and G. Zavattaro. A Foundational Theory of Contracts for Multi-party Service Composition. Fundamentals of Software Engineering 2007: Selected Contributions, 89:451--478, 2009.

Digital Library

[5]

L. C. Briand, Y. Labiche, and H. Sun. Investigating the Use of Analysis Contracts to Support Fault Isolation in Object Oriented Code. Proceedings of the 2002 ACM SIGSOFT International Symposium on Software testing and analysis, pages 70--80, 2002.

Digital Library

[6]

G. Castagna, N. Gesbert, and L. Padovani. A Theory of Contracts for Web Services. Proceedings of ACM Transactions on Programming Languages and Systems (TOPLAS), 31, 2009.

Digital Library

[7]

I. Ciupa and A. Leitner. Automatic testing based on Design by Contract. Proceedings of Net.ObjectDays Š05, 6th Annual International Conference on Object-Oriented and Internet-based Technologies, Concepts and Applications for a Networked World, pages 545--557, 2005.

[8]

G. Dai, X. Bai, Y. Wang, and F. Dai. Contract-Based Testing for Web Services. Proceedings of 31st Annual International Computer Software and Applications Conference, pages 517--526, 2007.

Digital Library

[9]

M. J. Hadley. WADL specifications. 2006. http://www.w3.org/Submission/wadl/.

[10]

J. H. Hausmann, R. Heckel, and M. Lohmann. Model-based development of Web service descriptions enabling a precise matching concept. In International Journal of Web Services Research, 2:67--85, 2005.

[11]

M. Laitkorpi, J. Koskinen, and T. Systa. A UML-based Approach for Abstracting Application Interfaces to REST-like Services. Proceedings of the 13th Working Conference on Reverse Engineering, pages 134--146, 2006.

Digital Library

[12]

M. Laitkorpi, P. Selonen, and T. Systa. Towards a Model Driven Process fo Designing ResTful Web Services. To appear: International Conference on Web Services, 2009.

Digital Library

[13]

M. Lohmann, L. Mariani, and R. Heckel. A Model-driven Approach to Discovery, Testing, and Monitoring of Web Services. In L. Baresi, E. Di Nitto (eds.): Test and Analysis of Web Services, pages 173--204, 2007.

[14]

B. Meyer. Applying Design by Contract. Computer, IEEE Computer, 25:40--51, 1992.

Digital Library

[15]

I. Porres and I. Rauf. From uml protocol statemachines to class contracts. Procceedings of the International Conference on Software Test, Verification and Validation(ICST 2010), 2010.

Digital Library

[16]

I. Rauf, M. Iqbal, and Z. Malik. UML Based Modeling of Web Service Composition-A Survey. Proceedings of the 2008 Sixth International Conference on Software Engineering Research, Management and Applications, pages 301--307, 2008.

Digital Library

[17]

L. Richardson and S. Ruby. RESTful Web Services. O'Reilly, 2007.

Digital Library

[18]

M. Siikarla, M. Laitkorpi, P. Selonen, and T. Systa. Transformations have to be developed ReST assured. Proceedings of the 1st international conference on Theory and Practice of Model Transformations, 2008.

Digital Library

[19]

O. UML. 2.2 Superstructure Specification. OMG ed, 2009. http://www.omg.org/spec/UML/2.2/.

[20]

J. Webber, S. Parastatidis, and I. Robinson. REST in Practice: Hypermedia and Systems Architecture. O'Reilly Media, 2010.

Digital Library

[21]

J. Zou, J. Mei, and Y. Wang. From Representation State Transfer to Accountable State Transfer Architecture. Proceedings of 2010 IEEE International Conference on Web Services, pages 99--306, 2010.

Digital Library

Cited By

Segura SParejo JTroya JRuiz-Cortes A(2018)Metamorphic Testing of RESTful Web APIsIEEE Transactions on Software Engineering10.1109/TSE.2017.276446444:11(1083-1099)Online publication date: 1-Nov-2018
https://doi.org/10.1109/TSE.2017.2764464
Rauf IVistbakka ITroubitsyna E(2018)Formal Verification of Stateful Services with REST APIs Using Event-B2018 IEEE International Conference on Web Services (ICWS)10.1109/ICWS.2018.00024(131-138)Online publication date: Jul-2018
https://doi.org/10.1109/ICWS.2018.00024
Seol YLee TPark DKim C(2016)NABIC: A New Access Portal to Search, Visualize, and Share Agricultural Genomics DataEvolutionary Bioinformatics10.4137/EBO.S3449312(EBO.S34493)Online publication date: Feb-2016
https://doi.org/10.4137/EBO.S34493
Show More Cited By

Index Terms

Designing level 3 behavioral RESTful web service interfaces
1. Human-centered computing
  1. Human computer interaction (HCI)
    1. Interaction paradigms
      1. Web-based interaction
2. Information systems

Recommendations

Modeling behavioral RESTful web service interfaces in UML
SAC '11: Proceedings of the 2011 ACM Symposium on Applied Computing

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. The Web Application Description Language (WADL) is a language to describe the ...
Service composition for end-users

RESTful services are becoming a popular technology for providing and consuming cloud services. The idea of cloud computing is based on on-demand services and their agile usage. This implies that also personal service compositions and workflows should be ...
A metamodel-based definition of a conversion mechanism between SOAP and RESTful web services

Nowadays there are several frameworks that permit the conversion between SOAP and RESTful web services. However, none of these frameworks defines a high-level characterization of the interchange process, hindering full understanding of this process. ...

Comments

Please enable JavaScript to view thecomments powered by Disqus.

Information & Contributors

Information

Published In

cover image ACM SIGAPP Applied Computing Review

ACM SIGAPP Applied Computing Review Volume 11, Issue 3

August 2011

57 pages

ISSN:1559-6915

EISSN:1931-0161

DOI:10.1145/2034594

Issue’s Table of Contents

Copyright © 2011 Authors.

Publisher

Association for Computing Machinery

New York, NY, United States

Publication History

Published: 01 August 2011

Published in SIGAPP Volume 11, Issue 3

Check for updates

Author Tags

Qualifiers

Research-article

Contributors

Other Metrics

View Article Metrics

Bibliometrics & Citations

Bibliometrics

Article Metrics

7
Total Citations
View Citations
445
Total Downloads

Downloads (Last 12 months)6
Downloads (Last 6 weeks)0

Reflects downloads up to 17 Feb 2025

Other Metrics

View Author Metrics

Citations

Cited By

Segura SParejo JTroya JRuiz-Cortes A(2018)Metamorphic Testing of RESTful Web APIsIEEE Transactions on Software Engineering10.1109/TSE.2017.276446444:11(1083-1099)Online publication date: 1-Nov-2018
https://doi.org/10.1109/TSE.2017.2764464
Rauf IVistbakka ITroubitsyna E(2018)Formal Verification of Stateful Services with REST APIs Using Event-B2018 IEEE International Conference on Web Services (ICWS)10.1109/ICWS.2018.00024(131-138)Online publication date: Jul-2018
https://doi.org/10.1109/ICWS.2018.00024
Seol YLee TPark DKim C(2016)NABIC: A New Access Portal to Search, Visualize, and Share Agricultural Genomics DataEvolutionary Bioinformatics10.4137/EBO.S3449312(EBO.S34493)Online publication date: Feb-2016
https://doi.org/10.4137/EBO.S34493
Foping FWalsh JRoche DWeippl EIndrawan-Santiago MSteinbauer MKotsis GKhalil I(2013)Design and Implementation of a Private RESTful API to Leverage the Power of an eCommerce PlatformProceedings of International Conference on Information Integration and Web-based Applications & Services10.1145/2539150.2539251(681-685)Online publication date: 2-Dec-2013
https://dl.acm.org/doi/10.1145/2539150.2539251
Moffett YDingel JBeaulieu A(2013)Verifying Protocol Conformance Using Software Model Checking for the Model-Driven Development of Embedded SystemsIEEE Transactions on Software Engineering10.1109/TSE.2013.1439:9(1307-13256)Online publication date: 1-Sep-2013
https://dl.acm.org/doi/10.1109/TSE.2013.14
Corredor IBernardos AIglesias JCasar J(2012)Model-Driven Methodology for Rapid Deployment of Smart Spaces Based on Resource-Oriented ArchitecturesSensors10.3390/s12070928612:7(9286-9335)Online publication date: 6-Jul-2012
https://doi.org/10.3390/s120709286
Hsieh MLin HYeh CLi KWu B(2012)A Mobile Application Framework for Rapid Integration of Ubiquitous Web ServicesProceedings of the 2012 9th International Conference on Ubiquitous Intelligence and Computing and 9th International Conference on Autonomic and Trusted Computing10.1109/UIC-ATC.2012.140(136-142)Online publication date: 4-Sep-2012
https://dl.acm.org/doi/10.1109/UIC-ATC.2012.140

View Options

Login options

Check if you have access through your login credentials or your institution to get full access on this article.

Full Access

Get this Publication

View options

PDF

View or Download as a PDF file.

eReader

View online with eReader.

Figures

Tables

Media

View Issue’s Table of Contents