Skip to main content
SpringerLink
Log in

Specifying Web Interfaces for Command-Line Applications Based on OpenAPI

  • Conference paper
  • First Online:
Service-Oriented Computing – ICSOC 2019 Workshops (ICSOC 2019)

Part of the book series: Lecture Notes in Computer Science ((LNPSE,volume 12019))

Included in the following conference series:

  • 885 Accesses

Abstract

Command-line applications help to deal with various different tasks, reaching from automation, text manipulation or document conversion to administrating databases or firewalls. Powerful orchestrations of those applications can be created, e.g., to build Continuous Delivery or decision support pipelines. If the functionality of those applications and their orchestrations shall be used within a service-oriented architecture or as a backend of a web application, a web-compatible interface is necessary, which is usually not provided. Thus, those applications need to be retrofitted with a web interface. In this paper, we present CL2HTTP, an approach to map command-line interfaces to HTTP interfaces using an extended form of the OpenAPI service description format. The extensions specify how HTTP requests are mapped to command-line invocations and how the command-line responses are mapped back to HTTP responses. Our approach does not require any programming to specify a web interface for command-line applications, is available for public use and supports deployment as a container or lambda function in cloud environments.

This is a preview of subscription content, log in via an institution to check access.

Access this chapter

Log in via an institution
Chapter
USD 29.95
Price excludes VAT (USA)
  • Available as PDF
  • Read on any device
  • Instant download
  • Own it forever
eBook
USD 39.99
Price excludes VAT (USA)
  • Available as EPUB and PDF
  • Read on any device
  • Instant download
  • Own it forever
Softcover Book
USD 54.99
Price excludes VAT (USA)
  • Compact, lightweight edition
  • Dispatched in 3 to 5 business days
  • Free shipping worldwide - see info

Tax calculation will be finalised at checkout

Purchases are for personal use only

Institutional subscriptions

Notes

  1. 1.

    http://cl2http.dwolt.de.

  2. 2.

    https://pandoc.org.

  3. 3.

    https://github.com/s3u/JSONPath.

  4. 4.

    https://apimatic.io/transformer.

  5. 5.

    https://tools.ietf.org/html/rfc3875.

References

  1. Blanning, R.W.: Model management systems: an overview. Decis. Support Syst. 9(1), 9–18 (1993)

    Article  Google Scholar 

  2. Delen, D., Demirkan, H.: Data, information and analytics as services. Decis. Support Syst. 55(1), 359–363 (2013)

    Article  Google Scholar 

  3. Demirkan, H., Delen, D.: Leveraging the capabilities of service-oriented decision support systems: putting analytics and big data in cloud. Decis. Support Syst. 55(1), 412–421 (2013)

    Article  Google Scholar 

  4. Deokar, A.V., El-Gayar, O.F., Aljafari, R.: Developing a semantic web-based distributed model management system: experiences and lessons learned. HICSS 2010, 1–10 (2010)

    Google Scholar 

  5. Ed-douibi, H., Cánovas Izquierdo, J.L., Cabot, J.: OpenAPItoUML: a tool to generate UML models from OpenAPI definitions. In: Mikkonen, T., Klamma, R., Hernández, J. (eds.) ICWE 2018. LNCS, vol. 10845, pp. 487–491. Springer, Cham (2018). https://doi.org/10.1007/978-3-319-91662-0_41

    Chapter  Google Scholar 

  6. Gannod, G.C., Mudiam, S.V., Lindquist, T.E.: Automated support for service-based software development and integration. J. Syst. Softw. 74(1), 65–71 (2005)

    Article  Google Scholar 

  7. Koren, I., Klamma, R.: The exploitation of OpenAPI documentation for the generation of web frontends. In: Companion Proceedings of WWW 2018, pp. 781–787 (2018)

    Google Scholar 

  8. OpenAPI Initiative: OpenAPI Specification (2018). http://spec.openapis.org/oas/v3.0.2

  9. Pautasso, C., Alonso, G.: From web service composition to megaprogramming. In: Shan, M.-C., Dayal, U., Hsu, M. (eds.) TES 2004. LNCS, vol. 3324, pp. 39–53. Springer, Heidelberg (2005). https://doi.org/10.1007/978-3-540-31811-8_4

    Chapter  Google Scholar 

  10. Peffers, K., Tuunanen, T., Rothenberger, M.A., Chatterjee, S.: A design science research methodology for information systems research. J. Manage. Inf. Syst. 24(3), 45–77 (2007)

    Article  Google Scholar 

  11. Senger, M., Rice, P., Oinn, T.: Soaplab - a unified sesame door to analysis tools. In: In UK e-Science All Hands Meeting, pp. 509–513 (2003)

    Google Scholar 

  12. Sferruzza, D., Rocheteau, J., Attiogbé, C., Lanoix, A.: A model-driven method for fast building consistent web services from OpenAPI-compatible models. In: Hammoudi, S., Pires, L.F., Selic, B. (eds.) MODELSWARD 2018. CCIS, vol. 991, pp. 9–33. Springer, Cham (2019). https://doi.org/10.1007/978-3-030-11030-7_2

    Chapter  Google Scholar 

  13. Spinellis, D.: Being a DevOps developer. IEEE Softw. 33(3), 4–5 (2016)

    Article  Google Scholar 

  14. Virmani, M.: Understanding DevOps & bridging the gap from continuous integration to continuous delivery. In: INTECH 2015, pp. 78–82. IEEE (2015)

    Google Scholar 

  15. Voss, A., Voss, J.: Fast-dm: a free program for efficient diffusion model analysis. Behav. Res. Methods 39(4), 767–775 (2007)

    Article  Google Scholar 

  16. Wettinger, J., Andrikopoulos, V., Leymann, F.: Automated Capturing and systematic usage of DevOps knowledge for cloud applications. In: IC2E 2015, pp. 60–65 (2015)

    Google Scholar 

  17. Wohlstadter, E., Jackson, S., Devanbu, P.: Generating wrappers for command line programs: the Cal-Aggie Wrap-O-Matic project. In: ICSE 2001, pp. 243–252 (2001)

    Google Scholar 

  18. Wolters, D., Heindorf, S., Kirchhoff, J., Engels, G.: Linking services to websites by leveraging semantic data. In: ICWS 2017, pp. 668–675. IEEE (2017)

    Google Scholar 

Download references

Author information

Authors and Affiliations

  1. Department of Computer Science, Paderborn University, Paderborn, Germany

    Dennis Wolters, Jonas Kirchhoff & Gregor Engels

Authors
  1. Dennis Wolters
    View author publications

    You can also search for this author in PubMed Google Scholar

  2. Jonas Kirchhoff
    View author publications

    You can also search for this author in PubMed Google Scholar

  3. Gregor Engels
    View author publications

    You can also search for this author in PubMed Google Scholar

Corresponding author

Correspondence to Dennis Wolters .

Editor information

Editors and Affiliations

  1. LAAS-CNRS, Toulouse, France

    Sami Yangui

  2. University of Sydney, Sydney, NSW, Australia

    Athman Bouguettaya

  3. Tianjin University, Tianjin, China

    Xiao Xue

  4. University of Lyon, Villeurbanne, France

    Noura Faci

  5. Télécom SudParis, Évry, France

    Walid Gaaloul

  6. Rochester Institute of Technology, Rochester, NY, USA

    Qi Yu

  7. University of Geosciences in Beijing, Beijing, China

    Zhangbing Zhou

  8. University of Toulouse 2, Toulouse, France

    Nathalie Hernandez

  9. University of São Paulo, São Paulo, Brazil

    Elisa Y. Nakagawa

Rights and permissions

Reprints and permissions

Copyright information

© 2020 Springer Nature Switzerland AG

About this paper

Check for updates. Verify currency and authenticity via CrossMark

Cite this paper

Wolters, D., Kirchhoff, J., Engels, G. (2020). Specifying Web Interfaces for Command-Line Applications Based on OpenAPI. In: Yangui, S., et al. Service-Oriented Computing – ICSOC 2019 Workshops. ICSOC 2019. Lecture Notes in Computer Science(), vol 12019. Springer, Cham. https://doi.org/10.1007/978-3-030-45989-5_3

Download citation

  • DOI: https://doi.org/10.1007/978-3-030-45989-5_3

  • Published:

  • Publisher Name: Springer, Cham

  • Print ISBN: 978-3-030-45988-8

  • Online ISBN: 978-3-030-45989-5

  • eBook Packages: Computer ScienceComputer Science (R0)

Publish with us

Policies and ethics

Search

Navigation