Towards a Framework for Systematic API Migrations
Typ
Stať ve sborníku
Pracoviště
Anotace
This work presents a framework for systematic Application Programming Interface (API) migrations that provides guidance for both manual and automated migration processes. The approach starts by matching methods from the old API version with those of the new version, followed by comparative syntactic and semantic analyses to produce migration steps. As a proof of concept, we implement the most challenging parts using structured, parameterized Artificial Intelligence (AI) queries, which also serve as a basis for evaluation. Our results demonstrate the feasibility and usefulness of this approach. Future work will focus on completing the full migration process while reducing reliance on AI due to its current limitations in reasoning. We also plan to evaluate the framework on real-world APIs to assess its effectiveness and general applicability.
Semantic Analysis of API Blueprint and OpenAPI Specification
Typ
Stať ve sborníku
Pracoviště
Anotace
This paper presents a comparative semantic analysis of API Blueprint and OpenAPI Specification, two widely used API description languages. It explores their structural and semantic differences, providing insights into their unique features and capabilities. A significant focus is placed on developing a robust method to convert API blueprint documents into OpenAPI format. This conversion blueprint is designed to maintain the semantic integrity of the original documents, and its referential implementation is provided as well. The study offers contributions to the field of REST API development, particularly for developers and organizations seeking to transition between these specifications without losing the essence of their REST API documentation.