Prof. Dr. Cesare Pautasso

APIstic: A Large Collection of OpenAPI Metrics

Souhaila Serbout, Cesare Pautasso

21st IEEE/ACM International Conference on Mining Software Repositories (MSR), Lisbon, Portugal, pp. 265 - 277

April 2024

Abstract

In the rapidly evolving landscape of web services, the significance of efficiently designed and well-documented APIs is paramount. In this paper, we present APIstic an API analytics dataset and exploration tool to navigate and segment APIs based on an extensive set of precomputed metrics extracted from OpenAPI specifications, sourced from GitHub, SwaggerHub, BigQuery and APIs.guru. These pre-computed metrics are categorized into structure, data model, natural language description, and security metrics. The extensive dataset of varied API metrics provides crucial insights into API design and documentation for both researchers and practitioners. Researchers can use APIstic as an empirical resource to extract refined samples, analyze API design trends, best practices, smells, and patterns. For API designers, it serves as a benchmarking tool to assess, compare, and improve API structures, data models, and documentation using metrics to select points of references among 1,275,568 valid OpenAPI specifications. The paper discusses potential use cases of the collected data and presents a descriptive analysis of selected API analytics metrics.

Download

URL: https://dl.acm.org/doi/10.1145/3643991.3644932

DOI: 10.1145/3643991.3644932

PDF: ▼apiace-msr2024-apistic.pdf (7MB)

Citation

Bibtex

@inproceedings{apiace:2024:msr,
	author = {Souhaila Serbout and Cesare Pautasso},
	title = {APIstic: A Large Collection of OpenAPI Metrics},
	booktitle = {21st IEEE/ACM International Conference on Mining Software Repositories (MSR)},
	year = {2024},
	month = {April},
	pages = {265 - 277},
	address = {Lisbon, Portugal},
	abstract = {In the rapidly evolving landscape of web services, the significance of efficiently designed and well-documented APIs is paramount. In this paper, we present APIstic an API analytics dataset and exploration tool to navigate and segment APIs based on an extensive set of precomputed metrics extracted from OpenAPI specifications, sourced from GitHub, SwaggerHub, BigQuery and APIs.guru.
These pre-computed metrics are categorized into structure, data model, natural language description, and security metrics.
The extensive dataset of varied API metrics provides crucial insights into API design and documentation for both researchers and practitioners. Researchers can use APIstic as an empirical resource to extract refined samples, analyze API design trends, best practices, smells, and patterns. For API designers, it serves as a benchmarking tool to assess, compare, and improve API structures, data models, and documentation using metrics to select points of references among 1,275,568 valid OpenAPI specifications.
The paper discusses potential use cases of the collected data and presents a descriptive analysis of selected API analytics metrics. },
	keywords = {dataset, metrics, OpenAPI},
	doi = {10.1145/3643991.3644932},
	url = {https://dl.acm.org/doi/10.1145/3643991.3644932}
}