Ioanna-Maria Stergiou, "Searching in REST service catalogues with OpenAPI descriptions", Diploma Work, School of Electrical and Computer Engineering, Technical University of Crete, Chania, Greece, 2021
https://doi.org/10.26233/heallink.tuc.90495
This work presents OpenPI QL, a query language for querying OpenAPI service descriptions. The basic idea behind OpenAPI QL approach is that the OpenAPI document is a description of a REST request with the corresponding responses. The request that is sent from client to the server, and the responses returned back to the client, are actions that OpenAPI describes thoroughly. An important factor of this work is the capability of determining whether data are usable for being searched. Equally important is the handling of data complexity. OpenAPI QL is modeled to deal with JSON files, which are semi-structured data. Moreover, OpenAPI QL requires that the user be syntactically familiar with SQL-like query languages. However, it is necessary for a user to deepen in REST architectural style but not in OpenAPI 3.0. A simple knowledge of API calls is enough to understand and use OpenAPI QL. To show proof of concept, OpenAPI QL system has been developed that supports query translation, execution and results viewing.