Proposal and application of a Technical Guide to adopt API-FIRST

Authors

DOI:

https://doi.org/10.15649/2346030X.4164

Keywords:

API-First, spring boot, open API, technical guide

Abstract

An innovation in the web API industry is the API-First software development approach. According to various authors in the academic field, studies related to this model are still scarce. However, some of its advocates claim that it generates multiple benefits for software development and companies.  In this work its adoption, we propose a technical guide for its application after exploring and describing it in depth. We evaluate and demonstrate this instrument in a real and local problem. The proposed guide is strongly oriented towards the use of specific technologies and tools that impacted the duration and complexity of the API developed.

Author Biographies

  • Juan Enriquez, Teacher and researcher

    Graduate in Computer Science (2003) at the National University of the South (Bahia Blanca), and Master in Systems and Informatics (2016) at the National University of Southern Patagonia (UNPA). Member of the Pragmatica Software Research Group of the ITA-UARG. Participates in different research projects since 2010. Teacher (Adjunct Professor) of various subjects in the Systems Analyst and Systems Degree program, at UNPA-UARG.

  • Héctor Reinaga, Professor and researcher

    Graduate in Systems (2003) at the National University of Southern Patagonia, Río Gallegos Academic Unit (UNPA-UARG); and Master in Systems and Informatics (2023) at UNPA-UARG. Member of the Pragmatica Software Research Group of the ITA-UARG. Participates in different research projects since 2003. Teacher (Adjunct Professor) of various subjects in the Systems Analyst and Systems Degree program, at UNPA-UARG. Member of the Advisory Committee of the UNPA-UARG School of Systems and Informatics.

  • Sandra Casas, Professor and researcher

    Graduate in Computer Science (1992) at the Universidad del Salvador (Buenos Aires), and PhD in Software Engineering (2008) at the Universidad Vigo (Spain). Member of the Pragmatica Software Research Group of the ITA-UARG. Participates in different research projects since 2001. Director of Research Projects since 2010. Teacher (Associate Professor) of various subjects in the Systems Analyst and Systems Degree program, at UNPA-UARG.

References

[1] L. Richardson, M. Amundsen y S. Ruby, RESTful Web APIs, O'Reilly Media, 2013.

[2] J. M. Rivero, S. Heil y J. Grigera, «MockAPI: An Agile Approach Supporting API-first Web Application Development,» (eds) Web Engineering. ICWE 2013. Lecture Notes in Computer Science. Springer, Berlin, Heidelberg., vol. 7977, pp. 7-21, 2013.

[3] W. Tan, Y. Fan, A. Ghoneim, M. A. Hossain y S. Dustdar, «From the Service-Oriented Architecture to the Web API Economy,» IEEE Internet Computing, vol. 20, nº 4, pp. 64-68, 2016.

[4] N. Beaulieu, S. M. Dascalu y E. Hand, «API-First Design: A Survey of the State of Academia and Industry,» ITNG 2022 19th International Conference on Information Technology-New Generations. Advances in Intelligent Systems and Computing, vol. 1421, pp. 73-79, 2022.

[5] P. (s.f.), «Guide to API-first,» [En línea]. Available: https://www.postman.com/api-first. [Último acceso: 29 11 24].

[6] N. Beaulieu, S. Dascalu y E. Hand, «API Integrator: A UI Design and Code Automation Application Supporting API-First Design,» ACIT '22: Proceedings of the 9th International Conference on Applied Computing & Information Technology, pp. 36-40, 2023.

[7] Postman, «State of the API Report,» 2023. [En línea]. Available: https://www.postman.com/state-of-api/2023/. [Último acceso: 29 11 2023].

[8] J. Lin, «Medium. API-first software development for modern organizations,» 2018. [En línea]. Available: https://medium.com/better-practices/api-first-software-development-for-modern-organizations-fdbfba9a66d3. [Último acceso: 11 09 2023].

[9] L. Trieloff, «Medium. Three Principles of API First Design,» 2017. [En línea]. Available: https://blog.developer.adobe.com/three-principles-of-api-first-design-fa6666d9f694. [Último acceso: 01 09 2023].

[10] O. Hämäläinen, «API-First Design with Modern Tools. Thesis, School of Business, Degree Programme in Business Information Technology,» 2019. [En línea]. Available: https://urn.fi/URN:NBN:fi:amk-2019060615295. [Último acceso: 23 10 2023].

[11] J. Wagner, «Swagger. Plan Your API-First Program,» [En línea]. Available: https://swagger.io/resources/articles/adopting-an-api-first-approach. [Último acceso: 07 09 2023].

[12] API: Addicts (s.f.), «Implementa API-First con las APITools,» [En línea]. Available: https://www.apiaddicts.org/apitools. [Último acceso: 10 10 2023].

[13] K. Lane, The API-First Transformation, Postman Inc., 2022, p. 262.

[14] K. Lane, «APIscene,» [En línea]. Available: https://www.apiscene.io/author/kin-lane. [Último acceso: 29 07 2024].

[15] M. Dudjak y G. Martinovic, «An API-first methodology for designing a microservice-based Backend as a Service platform.,» Information technology and control, vol. 49, nº 2, pp. 206-223, 2020.

[16] J. J. Londoño Tirado, «Gobierno de APIs, implementación y experimentación con API-First y OpenAPI en el proyecto P2P energía transactiva. Trabajo de grado. Universidad de Antioquia,» [En línea]. Available: https://hdl.handle.net/10495/29121. [Último acceso: 20 10 2023].

[17] J. Larsson y L. Åkermark, «The value of implementing API-First as a methodology when developing APIs (Dissertation) - Jonkoping University,» 2021. [En línea]. Available: https://urn.kb.se/resolve?urn=urn:nbn:se:hj:diva-54311. [Último acceso: 26 09 2023].

[18] K. Peffers, T. Tuunanen, M. A. Rothenberger y S. Chatterjee, «A design science research methodology for information systems research.,» Journal of Management Information Systems: JMIS, vol. 24, nº 3, pp. 45-77, 2007.

[19] R. Wieringa y A. Morali, «Technical Action Research as a Validation Method in Information Systems Design Science,» Design Science Research in Information Systems. Advances in Theory and Practice, vol. 7286, pp. 220-238, 2012.

[20] G. Hadad, J. Doorn y G. Kaplan, «Explicitar Requisitos del Software usando Escenarios,» Workshop em Engenharia de Requisitos, 2009.

[21] A. Cleven, P. Gubler y K. M. Hüner, «Design alternatives for the evaluation of design science research artifacts,» International Conference on Design Science Research in Information Systems and Technology, 2009.

Downloads

Published

2025-09-01

How to Cite

[1]
J. G. Enriquez, H. Reinaga, and S. I. Casas, “Proposal and application of a Technical Guide to adopt API-FIRST”, AiBi Revista de Investigación, Administración e Ingeniería, vol. 13, no. 3, pp. 01–11, Sep. 2025, doi: 10.15649/2346030X.4164.
Crossref
Scopus
Google Scholar
Europe PMC

Downloads

Download data is not yet available.

Issue

Vol. 13 No. 3 (2025): Septiembre-Diciembre

Section

Research Articles

License

Copyright (c) 2025 AiBi Journal of Research, Administration and Engineering

Creative Commons License

This work is licensed under a Creative Commons Attribution 4.0 International License.

The journal offers open access under a Creative Commons Attibution License 

Licencia Creative Commons
This work is under license Creative Commons Attribution (CC BY 4.0).

Similar Articles

1-10 of 97

You may also start an advanced similarity search for this article.