Advertisement

OpenAPItoUML: A Tool to Generate UML Models from OpenAPI Definitions

  • Hamza Ed-douibi
  • Javier Luis Cánovas Izquierdo
  • Jordi Cabot
Conference paper
Part of the Lecture Notes in Computer Science book series (LNCS, volume 10845)

Abstract

REpresentational State Transfer (REST) has become the prominent architectural style for designing Web APIs. This increasing adoption has triggered the creation of languages to formally describe REST APIs, thus facilitating and promoting their usage. In particular, a consortium of companies has created the OpenAPI Initiative, which aims at creating a vendor neutral, portable, standard and open specification for describing REST APIs. OpenAPI specification has become the choice of reference for describing REST APIs, and its adopters can benefit from a plethora of tools for documenting, developing and integrating REST APIs. However, current documentation tools for OpenAPI only describe REST APIs in HTML pages using text and code samples, thus requiring a considerable effort to visualize and understand what the APIs offer. In this paper, we propose a tool called OpenAPItoUML, which generates UML models from OpenAPI definitions, thus offering a better visualization of the data model and operations of REST APIs.

Keywords

OpenAPI UML REST API 

References

  1. 1.
  2. 2.
    Cánovas Izquierdo, J.L., Cabot, J.: JSONDiscoverer: visualizing the schema lurking behind JSON documents. Knowl.-Based Syst. 103, 52–55 (2016)CrossRefGoogle Scholar
  3. 3.
    Ed-douibi, H., Cánovas Izquierdo, J.L., Cabot, J.: Example-driven web API specification discovery. In: Anjorin, A., Espinoza, H. (eds.) ECMFA 2017. LNCS, vol. 10376, pp. 267–284. Springer, Cham (2017).  https://doi.org/10.1007/978-3-319-61482-3_16CrossRefGoogle Scholar

Copyright information

© Springer International Publishing AG, part of Springer Nature 2018

Authors and Affiliations

  1. 1.UOCBarcelonaSpain
  2. 2.ICREABarcelonaSpain

Personalised recommendations