A UML Profile for OData Web APIs

Conference paper
Part of the Lecture Notes in Computer Science book series (LNCS, volume 10360)


More and more individuals and organizations are making their data available online publicly, resulting in a growing market of technologies and services to help consume data and extract its real value. One of the several ways to publish data on the Web is via Web APIs. Unlike other approaches like RDF, Web APIs provide a simple way to query structured data by relying only on the HTTP protocol. Standards and frameworks such as Open API or API Blueprint offer a way to create Web APIs but OData stands out from the rest as it is specifically tailored to deal with data sources. However, creating an OData Web API is a hard and time-consuming task for data providers as they have to choose between relying on commercial solutions, which are heavy and require a deep knowledge of their corresponding platforms, or create a customized solution to share their data. We propose an approach that leverages on model-driven techniques to facilitate the development of OData Web APIs. The approach relies on a UML profile for OData allowing to annotate a UML class diagram with OData stereotypes. In this paper we describe the profile and show how class diagrams can be automatically annotated with such profile.


UML OData Web API 



This work has been supported by the Spanish government (TIN2016-75944-R project).


  1. 1.
    Cabot, J., Gogolla, M.: Object constraint language (OCL): a definitive guide. In: Formal Methods for Model-Driven Engineering, pp. 58–90 (2012)Google Scholar
  2. 2.
    Ed-Douibi, H., Izquierdo, J.L.C., Gómez, A., Tisi, M., Cabot, J.: EMF-REST: generation of restful APIs from models. In: SAC Symposium, pp. 1446–1453 (2016)Google Scholar
  3. 3.
    Fraternali, P.: Tools and approaches for developing data-intensive web applications: a survey. CSUR 31(3), 227–263 (1999)CrossRefGoogle Scholar
  4. 4.
    Pizzo, M., Handl, R., Zurmuehl, M.: Odata version 4.0 part 1: protocol. Technical report, OASIS (2014)Google Scholar
  5. 5.
    Pizzo, M., Handl, R., Zurmuehl, M.: Odata version 4.0 part 3: Common Schema Definition Language (CSDL). Technical report, OASIS (2014)Google Scholar
  6. 6.
    Rivero, J.M., Heil, S., Grigera, J., Gaedke, M., Rossi, G.: MockAPI: an agile approach supporting API-first web application development. In: ICWE Conference, pp. 7–21 (2013)Google Scholar
  7. 7.
    Rossi, G., Pastor, O., Schwabe, D., Olsina, L. (eds.): Web Engineering: Modelling and Implementing Web Applications. Human-Computer Interaction Series. Springer, London (2008)Google Scholar
  8. 8.
    Schwinger, W., Retschitzegger, W., Schauerhuber, A., Kappel, G., Wimmer, M., Pröll, B., Cachero Castro, C., Casteleyn, S., De Troyer, O., Fraternali, P., et al.: A survey on web modeling approaches for ubiquitous web applications. IJWIS 4(3), 234–305 (2008)Google Scholar
  9. 9.
    Segura, Á.M., Cuadrado, J.S., de Lara, J.: ODaaS: towards the model-driven engineering of open data applications as data services. In: EDOCW Workshop, pp. 335–339 (2014)Google Scholar
  10. 10.
    Selic, B.: The pragmatics of model-driven development. IEEE Softw. 20(5), 19–25 (2003)CrossRefGoogle Scholar
  11. 11.
    Valderas, P., Pelechano, V.: A survey of requirements specification in model-driven development of web applications. TWEB 5(2), 10 (2011)CrossRefGoogle Scholar
  12. 12.
    Vallecillo, A., Koch, N., Cachero, C., Comai, S., Fraternali, P., Garrigós, I., Gómez, J., Kappel, G., Knapp, A., Matera, M., Meliá, S., Moreno, N., Pröll, B., Reiter, T., Retschitzegger, W., Rivera, J.E., Schauerhuber, A., Schwinger, W., Wimmer, M., Zhang, G.: MDWEnet: a practical approach to achieving interoperability of model-driven web engineering methods. In: MDWE Workshop, @ICWE (2007)Google Scholar

Copyright information

© Springer International Publishing AG 2017

Authors and Affiliations

  1. 1.UOCBarcelonaSpain
  2. 2.ICREABarcelonaSpain

Personalised recommendations