API Integrator: A UI Design and Code Automation Application Supporting API-First Design
Pages 36 - 40
Abstract
Microservice Architecture (MSA) is a standard for solving the technical challenges of distributed software systems. Design methodologies assist in making decisions about the functionality encapsulated by each microservice in a system. Despite the documentation supporting microservice design, challenges remain in defining microservice boundaries and concise APIs exposing business capacities of the modern distributed, data-intensive, microservice-based system.
API-First Design is an emerging methodology for enterprise system design. Its primary principle suggests that software design focus on well-defined APIs as its foundation. In its infancy, research, documentation, and tools that assist in adopting an API-First Design approach are minimal. The project discussed in this paper provides the research community with a set of practitioner-defined features and a prototype for an application intended to help promote the adoption of API-First Design via an API-Driven UI design and code generation application.
References
[1]
Nicole Beaulieu, Sergiu M. Dascalu, and Emily Hand. 2022. API-First Design: A Survey of the State of Academia and Industry. In ITNG 2022 19th International Conference on Information Technology-New Generations, Shahram Latifi (Ed.). Springer International Publishing, Cham, 73–79.
[2]
Alessandro Bertoni. 2020. Data-driven design in concept development: systematic review and missed opportunities, In Proceedings of the Design Society: DESIGN Conference. Proceedings of the Design Society: DESIGN Conference 1, 101–110. https://doi.org/10.1017/dsd.2020.4
[3]
Chen-Fu Chien, Rhoann Kerh, Kuo-Yi Lin, and Annie Pei-I Yu. 2016. Data-driven innovation to capture user-experience product design: An empirical study for notebook visual aesthetics design. Computers & Industrial Engineering 99 (2016), 162–173.
[4]
Biplab Deka, Zifeng Huang, Chad Franzen, Joshua Hibschman, Daniel Afergan, Yang Li, Jeffrey Nichols, and Ranjitha Kumar. 2017. Rico: A Mobile App Dataset for Building Data-Driven Design Applications. In Proceedings of the 30th Annual ACM Symposium on User Interface Software and Technology (Québec City, QC, Canada) (UIST ’17). Association for Computing Machinery, New York, NY, USA, 845–854. https://doi.org/10.1145/3126594.3126651
[5]
Steven X Ding. 2014. Data-driven design of fault diagnosis and fault-tolerant control systems. Springer, London, London.
[6]
Mario Dudjak and Goran Martinovic. 2020. An API-first methodology for designing a microservice-based Backend as a Service platform. Inf. Technol. Control. 49 (2020), 206–223.
[7]
Eric Evans. 2004. Domain-Driven Design: Tackling Complexity in the Heart of Software. Addison-Wesley Professional, United States.
[8]
Martin Fowler and James Lewis. 2014. Microservices. http://martinfowler.com/articles/microservices.html Accessed October 17, 2021.
[9]
Javad Ghofrani and Daniel Lübke. 2018. Challenges of Microservices Architecture: A Survey on the State of the Practice. In ZEUS Workshop. http://CEUR-WS.org, Dresden, Germany, 1–8.
[10]
Martin Gontovnikas. 2020. The business value of API-first design. https://auth0.com/blog/the-business-value-of-api-first-design/ Accessed October 17, 2021.
[11]
Benjamin Götz, Daniel Schel, Dennis Bauer, Christian Henkel, Peter Einberger, and Thomas Bauernhansl. 2018. Challenges of production microservices. Procedia CIRP 67(2018), 167–172.
[12]
Merima Kulin, Carolina Fortuna, Eli De Poorter, Dirk Deschrijver, and Ingrid Moerman. 2016. Data-driven design of intelligent wireless networks: An overview and tutorial. Sensors 16, 6 (2016), 790.
[13]
Aaron Lazar. 2018. 8 reasons why architects love API driven architecture. https://hub.packtpub.com/architects-love-api-driven-architecture/. Accessed October 17, 2021.
[14]
OMG MDA. 2008. Object Management Group Model Driven Architecture. Accessed October 17, 2021.
[15]
Lauren Murphy, Mary Beth Kery, Oluwatosin Alliyu, Andrew Macvean, and Brad A. Myers. 2018. API Designers in the Field: Design Practices and Challenges for Creating Usable APIs. In 2018 IEEE Symposium on Visual Languages and Human-Centric Computing (VL/HCC). IEEE, Lisbon, Portugal, 249–258. https://doi.org/10.1109/VLHCC.2018.8506523
[16]
Mark Richters and Martin Gogolla. 1998. On Formalizing the UML Object Constraint Language OCL. In Conceptual Modeling – ER ’98, Tok-Wang Ling, Sudha Ram, and Mong Li Lee (Eds.). Springer Berlin Heidelberg, Berlin, Heidelberg, 449–464.
[17]
José Matías Rivero, Sebastian Heil, Julián Grigera, Martin Gaedke, and Gustavo Rossi. 2013. MockAPI: An Agile Approach Supporting API-first Web Application Development. In Web Engineering, Florian Daniel, Peter Dolog, and Qing Li (Eds.). Springer Berlin Heidelberg, Berlin, Heidelberg, 7–21.
[18]
Ajv JSON schema validator. 2021. AJV JSON Validator. https://ajv.js.org. Accessed December 12, 2021.
[19]
Yogesh Simmhan, Pushkara Ravindra, Shilpa Chaturvedi, Malati Hegde, and Rashmi Ballamajalu. 2018. Towards a data-driven IoT software architecture for smart city utilities. Software: Practice and Experience 48, 7 (2018), 1390–1416.
[20]
Jacopo Soldani, Damian Andrew Tamburri, and Willem-Jan van den Heuvel. 2018. The pains and gains of microservices: A Systematic grey literature review. J. Syst. Softw. 146(2018), 215–232.
[21]
Ian Sommerville. 2015. Software Engineering(10 ed.). Pearson, United States.
[22]
EV Sunitha and Philip Samuel. 2018. Object constraint language for code generation from activity models. Information and Software Technology 103 (2018), 92–111.
[23]
Creative Tim. 2022. Creative Tim. https://www.creative-tim.com Accessed March 10, 2021.
[24]
Chris Tozzi. 2020. The benefits of API-driven development and how you can implement it. https://www.mertech.com/blog/api-driven-development Accessed October 17, 2021.
[25]
Vaughn Vernon. 2016. Domain-driven design distilled. Addison-Wesley Professional, United States.
[26]
Luis Weir. 2019. Enterprise API Management: Design and deliver valuable business APIs. Packt Publishing Ltd, Birmingham, UK.
[27]
Erik Wilde. 2021. Jeff Bezos’ API Mandate: What the five rules mean and do. https://blog.axway.com/amplify-products/api-management/jeff-bezos-api-mandate Accessed October 17, 2021.
[28]
Erik Wilde and Mike Amundsen. 2019. The Challenge of API Management: API Strategies for Decentralized API Landscapes. In Companion Proceedings of The 2019 World Wide Web Conference (San Francisco, USA) (WWW ’19). Association for Computing Machinery, New York, NY, USA, 1327–1328. https://doi.org/10.1145/3308560.3320089
Index Terms
- API Integrator: A UI Design and Code Automation Application Supporting API-First Design
Recommendations
Decoupled design: building applications on the NetBeans platform
OOPSLA '06: Companion to the 21st ACM SIGPLAN symposium on Object-oriented programming systems, languages, and applicationsThe NetBeans Platform is the open-source NetBeans Integrated Development Environment (IDE) less those modules that make it a development tool. The platform is a "generic application" - a runtime which can be used to develop applications.One of the key ...
Web API design considerations for resolving inherent issues in web environment
The recent trend in web application development is moving towards exposing the service functionality through application programming interface (API). Many web-based services start to offer APIs to support application-to-application integration with ...
Decoupled design: building applications on the NetBeans platform
OOPSLA '06: Companion to the 21st ACM SIGPLAN symposium on Object-oriented programming systems, languages, and applicationsThe NetBeans Platform is the open-source NetBeans Integrated Development Environment (IDE) less those modules that make it a development tool. The platform is a "generic application" - a runtime which can be used to develop applications.One of the key ...
Comments
Please enable JavaScript to view thecomments powered by Disqus.Information & Contributors
Information
Published In
May 2022
81 pages
ISBN:9781450397605
DOI:10.1145/3543895
Copyright © 2022 ACM.
Permission to make digital or hard copies of all or part of this work for personal or classroom use is granted without fee provided that copies are not made or distributed for profit or commercial advantage and that copies bear this notice and the full citation on the first page. Copyrights for components of this work owned by others than ACM must be honored. Abstracting with credit is permitted. To copy otherwise, or republish, to post on servers or to redistribute to lists, requires prior specific permission and/or a fee. Request permissions from [email protected]
Publisher
Association for Computing Machinery
New York, NY, United States
Publication History
Published: 26 January 2023
Check for updates
Author Tags
Qualifiers
- Research-article
- Research
- Refereed limited
Conference
ACIT 2022
ACIT 2022: The 9th International Conference on Applied Computing & Information Technology
May 25 - 26, 2022
Virtual Event, USA
Contributors
Other Metrics
Bibliometrics & Citations
Bibliometrics
Article Metrics
- 0Total Citations
- 94Total Downloads
- Downloads (Last 12 months)42
- Downloads (Last 6 weeks)1
Reflects downloads up to 23 Jan 2025
Other Metrics
Citations
View Options
Login options
Check if you have access through your login credentials or your institution to get full access on this article.
Sign inFull Access
View options
View or Download as a PDF file.
PDFeReader
View online with eReader.
eReaderHTML Format
View this article in HTML Format.
HTML Format