Enriching API Descriptions by Adding API Profiles Through Semantic Annotation

  • Meherun Nesa Lucky
  • Marco Cremaschi
  • Barbara Lodigiani
  • Antonio Menolascina
  • Flavio De Paoli
Conference paper
Part of the Lecture Notes in Computer Science book series (LNCS, volume 9936)


In recent years several description tools and formats have been introduced for describing REST Web APIs both in human and machine readable formats. Although these descriptions provide functional information about the APIs (e.g. HTTP methods, URIs, model schema, etc.), the information that qualifies the properties of APIs (e.g. classification of input arguments and response data) is missing. We envisage that providing a complete set of information to the users will facilitate the composition of APIs to fulfil users’ specific needs.

This paper analyses the current state of the art in Web API Descriptions and Semantic Annotations to show that although there are solutions with semantic capabilities, most of them fails to add semantic annotations automatically or semi-automatically. Moreover, advanced technical skills are needed to manage semantics and compose different Web APIs, which reduce the number of potential users of such solutions. The goal is to enhance actual API descriptions by creating a simple description format to annotate properties at semantic level to support semi-automatic composition. To achieve this goal, we propose an extension of the Open API Initiative (OAI) specification to create comprehensive descriptions. The approach focuses on the emerging concept of API Profiling to add descriptive information of data semantics by addressing Dublin Core Application Profile (DCAP) guidelines.


  1. 1.
    Danielsen, P.J., Jeffrey, A.: Validation and interactivity of web API documentation. In: 2013 IEEE 20th International Conference on Web Services (ICWS), pp. 523–530. IEEE (2013)Google Scholar
  2. 2.
    Gupta, S., Szekely, P., Knoblock, C.A., Goel, A., Taheriyan, M., Muslea, M.: Karma: a system for mapping structured sources into the semantic web. In: Simperl, E., Norton, B., Mladenic, D., Valle, E.D., Fundulaki, I., Passant, A., Troncy, R. (eds.) ESWC 2012. LNCS, vol. 7540, pp. 430–434. Springer, Heidelberg (2012)Google Scholar
  3. 3.
    Lafferty, J., McCallum, A., Pereira, F.C.: Conditional random fields: probabilistic models for segmenting and labeling sequence data, pp. 282–289 (2001)Google Scholar
  4. 4.
    Lanthaler, M., Gütl, C.: A semantic description language for restful data services to combat semaphobia. In: Digital Ecosystems and Technologies Conference (DEST), 2011 Proceedings of the 5th IEEE International Conference on Digital Ecosystems and Technologies, pp. 47–53. IEEE (2011)Google Scholar
  5. 5.
    Lanthaler, M., Gütl, C.: Hydra: a vocabulary for hypermedia-driven web APIs. In: LDOW 996 (2013)Google Scholar
  6. 6.
    Mayer, S., Inhelder, N., Verborgh, R., Van de Walle, R., Mattern, F.: Configuration of smart environments made simple: combining visual modeling with semantic metadata and reasoning. In: Internet of Things (IOT), 2014 International Conference on the Internet of Things, pp. 61–66. IEEE (2014)Google Scholar
  7. 7.
    Mitra, R.: Rapido: a sketching tool for web API designers. In: Proceedings of the 24th International Conference on World Wide Web Companion, pp. 1509–1514. International World Wide Web Conferences Steering Committee (2015)Google Scholar
  8. 8.
    Myers, B.A., Jeong, S.Y., Xie, Y., Beaton, J., Stylos, J., Ehret, R., Karstens, J., Efeoglu, A., Busse, D.K.: Studying the documentation of an API for enterprise service-oriented architecture. IGI Global (2012)Google Scholar
  9. 9.
    Panziera, L., De Paoli, F.: A framework for self-descriptive restful services. In: Proceedings of the 22nd International Conference on World Wide Web Companion, pp. 1407–1414. International World Wide Web Conferences Steering Committee (2013)Google Scholar
  10. 10.
    Schmachtenberg, M., Bizer, C., Paulheim, H.: Adoption of the linked data best practices in different topical domains. In: Mika, P., et al. (eds.) ISWC 2014, Part I. LNCS, vol. 8796, pp. 245–260. Springer, Heidelberg (2014)Google Scholar
  11. 11.
    Sheng, Q.Z., Qiao, X., Vasilakos, A.V., Szabo, C., Bourne, S., Xu, X.: Web services composition: a decades overview. Inf. Sci. 280, 218–238 (2014)CrossRefGoogle Scholar
  12. 12.
    Sheth, A.P., Gomadam, K., Lathem, J.: SA-REST: semantically interoperable and easier-to-use services and mashups. IEEE Internet Comput. 11(6), 91 (2007)CrossRefGoogle Scholar
  13. 13.
    Steiner, T., Algermissen, J.: Fulfilling the hypermedia constraint via HTTP OPTIONS, the HTTP vocabulary in RDF, and link headers. In: Proceedings of the Second International Workshop on RESTful Design, pp. 11–14. ACM (2011)Google Scholar
  14. 14.
    Taheriyan, M., Knoblock, C.A., Szekely, P., Ambite, J.L.: Rapidly integrating services into the linked data cloud. In: Cudré-Mauroux, P., et al. (eds.) ISWC 2012, Part I. LNCS, vol. 7649, pp. 559–574. Springer, Heidelberg (2012)CrossRefGoogle Scholar
  15. 15.
    Taheriyan, M., Knoblock, C.A., Szekely, P., Ambite, J.L.: Semi-automatically modeling web APIs to create linked APIs. In: Proceedings of the ESWC 2012 Workshop on Linked APIs (2012)Google Scholar
  16. 16.
    Tosi, D., Morasca, S.: Supporting the semi-automatic semantic annotation of web services: a systematic literature review. Inf. Softw. Technol. 61, 16–32 (2015)CrossRefGoogle Scholar
  17. 17.
    Tsouroplis, R., Petychakis, M., Alvertis, I., Biliri, E., Lampathaki, F., Askounis, D.: Community-based API builder to manage APIs and their connections with cloud-based services. In: CAiSE Forum (2015)Google Scholar
  18. 18.
    Vandenbussche, P.Y., Atemezing, G.A., Poveda-Villalón, M., Vatant, B.: Linked open vocabularies (LOV): a gateway to reusable semantic vocabularies on the web. Semant. Web (Preprint) 1–16 (2015)Google Scholar
  19. 19.
    Verborgh, R., Harth, A., Maleshkova, M., Stadtmüller, S., Steiner, T., Taheriyan, M., Van de Walle, R.: Survey of semantic description of REST APIs. In: Pautasso, C., Wilde, E., Alarcon, R. (eds.) REST: Advanced Research Topics and Practical Applications, pp. 69–89. Springer, New York (2014)CrossRefGoogle Scholar
  20. 20.
    Verborgh, R., Mannnens, E., Van de Walle, R.: Bottom-up web APIs with self-descriptive responses. In: Proceedings of the First Karlsruhe Service Summit Workshop-Advances in Service Research, p. 143. KIT Scientific Publishing (2015)Google Scholar
  21. 21.
    Verborgh, R., Steiner, T., Van Deursen, D., De Roo, J., Van de Walle, R., Vallés, J.G.: Description and interaction of restful services for automatic discovery and execution. In: 2011 FTRA International Workshop on Advanced Future Multimedia Services (AFMS 2011). FTRA (2011)Google Scholar
  22. 22.
    Verborgh, R., Steiner, T., Van Deursen, D., De Roo, J., Van de Walle, R., Vallés, J.G.: Capturing the functionality of web services with functional descriptions. Multimedia Tools Appl. 64(2), 365–387 (2013)CrossRefGoogle Scholar
  23. 23.
    Wilde, E.: The “profile” link relation type. https://www.ietf.org/rfc/rfc6906.txt. Accessed 24 May 2016
  24. 24.
    Zhang, Z.: Start small, build complete: effective and efficient semantic table interpretation using tableminer. Under Transpar. Rev.: Semant. Web J. (2014)Google Scholar
  25. 25.
    Zhang, Z.: Towards efficient and effective semantic table interpretation. In: Mika, P., et al. (eds.) ISWC 2014, Part I. LNCS, vol. 8796, pp. 487–502. Springer, Heidelberg (2014)Google Scholar

Copyright information

© Springer International Publishing Switzerland 2016

Authors and Affiliations

  • Meherun Nesa Lucky
    • 1
  • Marco Cremaschi
    • 1
  • Barbara Lodigiani
    • 1
  • Antonio Menolascina
    • 1
  • Flavio De Paoli
    • 1
  1. 1.University of Milan - BicoccaMilanItaly

Personalised recommendations