ТЕКСТОВИЙ СТАНДАРТ ОПИСУ API ЯК ІНСТРУМЕНТ ПІДВИЩЕННЯ ЯКОСТІ ТЕСТУВАННЯ ПРОГРАМНОГО ЗАБЕЗПЕЧЕННЯ
DOI:
https://doi.org/10.34185/1562-9945-4-165-2026-17Ключові слова:
тест-кейс, MADS, Confluence, бізнес-аналітик, специфікація, REST API, програмне забезпечення, ендпоінтАнотація
У сучасній розробці програмного забезпечення якість тестування API-інтерфейсів суттєво залежить від повноти їх документування. Актуальність дослідження зумовлена відсутністю єдиного стандарту для текстового опису API у корпоративній документації - Confluence, Google Docs та аналогічних системах. Встановлено, що бізнес-аналітики наприклад, описують ендпоінти довільно, так в одних документах зазначається лише URL, в інших - лише назва операції, тоді як інформація про параметри, коди помилок та авторизацію відсутня. Це призводить до неповного тестового покриття та збільшення кількості дефектів, що виявляються на пізніх стадіях розробки. Метою дослідження є розробка мінімального стандарту текстового опису API - MADS (Minimal API Description Standard) - та обґрунтування його структури на основі аналізу академічних джерел і реальної практики тестування. Запропонований стандарт містить десять полів, згрупованих у чотири блоки: ідентифікація ендпоінту, вхідні дані, вихідні дані та контекст безпеки. В статті проведено дослідження яке демонструє, що застосування MADS дозволяє тестувальнику безпосередньо формувати повний набір тест-кейсів, що охоплюють позитивні сценарії, граничні значення та обробку помилок, без додаткових уточнень вимог. Як результат це впливає на якість вихідного продукта.
Посилання
Unified.to. (2024). 2024 State of SaaS APIs: API Specifications and Documentation. https://unified.to/blog/2024_state_of_saas_apis_api_specifications_and_documentation
Hrytsyuk, Yu. I., & Mukha, T. O. (2020). Metody vyznachennia yakosti prohramnoho zabez-pechennia [Methods for determining software quality]. Naukovyi visnyk NLTU Ukrainy, 30(1), 158–167. https://doi.org/10.36930/40300127
Hrytsyuk, Yu. I. (2022). Systema kompleksnoho otsiniuvannia yakosti prohramnoho zabez-pechennia [Comprehensive software quality assessment system]. Naukovyi visnyk NLTU Ukrainy, 32(2), 81–95. https://doi.org/10.36930/40320213
Hrytsyuk, P. Yu., Ivanyshyn, A. V., & Hrytsyuk, Yu. I. (2023). Zabezpechennia yakosti prohramnoho produktu za standartom IEEE 730-2014 [Software product quality assurance per IEEE 730-2014]. Naukovyi visnyk NLTU Ukrainy, 33(2), 101–117. https://doi.org/10.36930/40330214
International Software Testing Qualifications Board. (2024). Certified Tester Foundation Level Syllabus v4.0.1. https://istqb.org
Torskyi, O. I., & Hrytsyuk, Yu. I. (2025). Zastosuvannia mashynnoho navchannia modelei dlia pidvyshchennia efektyvnosti avtomatyzovanoho testuvannia [Application of ML models for im-proving automated testing efficiency]. Scientific Bulletin of UNFU, 35(4), 142–149. https://doi.org/10.36930/40350416
Trofymenko, O. H., & Dyka, A. I. (2024). Testuvannia ta zabezpechennia yakosti prohramnykh system [Testing and QA of software systems]. Feniks. https://doi.org/10.32837/11300.27717
Natsionalnyi universytet «Lvivska politekhnika». (2025). Formuvannia tekhnichnoi dokumen-tatsii IT proiektiv [Formation of technical documentation of IT projects]. Information Systems and Networks, 18, 261–270.
Uddin, G., & Robillard, M. P. (2015). How API documentation fails. IEEE Software, 32(4), 68–75. https://doi.org/10.1109/MS.2014.80
Meng, M., Steinhardt, S., & Schubert, A. (2018). Application Programming Interface Documen-tation: What Do Software Developers Want? Journal of Technical Writing and Communication, 48(3), 295–330. https://doi.org/10.1177/0047281617721853
Zibran, M. F., Nabi, N., Roy, C. K., & Bhavsar, V. C. (2019). What Should I Document? A Pre-liminary Systematic Mapping Study (arXiv:1907.13260). arXiv. https://arxiv.org/abs/1907.13260
Golmohammadi, A., Zhang, M., & Arcuri, A. (2023). Testing RESTful APIs: A Survey. ACM Transactions on Software Engineering and Methodology, 33(1). https://doi.org/10.1145/3617175
Coblenz, M., Guo, W., Voozhian, K., & Foster, J. S. (2023). A Qualitative Study of REST API Design and Specification Practices. 2023 IEEE Symposium on Visual Languages and Human-Centric Computing (VL/HCC), 148–157. https://doi.org/10.1109/VL-HCC57772.2023.00025
Kim, M., Corradini, D., Sinha, S., Orso, A., Pasqua, M., Tzoref-Brill, R., & Ceccato, M. (2023). Enhancing REST API Testing with NLP Techniques. Proceedings of ISSTA 2023, 1232–1243. https://doi.org/10.1145/3597926.3598131
Sohan, S. M., Anslow, C., & Maurer, F. (2017). A study of the effectiveness of usage examples in REST API documentation. IEEE VL/HCC, 53–61. https://doi.org/10.1109/VLHCC.2017.8103450
Google Cloud. (2024). What is Model Context Protocol (MCP) A guide. https://cloud.google.com/discover/what-is-model-context-protocol
International Software Testing Qualifications Board. (2024). CTAL-TAE Syllabus v2.0. https://istqb.org
International Software Testing Qualifications Board. (2024). CT-TAS Syllabus v1.0. https://istqb.org
International Software Testing Qualifications Board. (2021). CT-AI Syllabus v1.0. https://astqb.org
OpenAPI Initiative. (2021). OpenAPI Specification v3.1.1. https://spec.openapis.org/oas/v3.1.1.html
OWASP Foundation. (2023). OWASP API Security Top 10 – 2023. https://owasp.org/API-Security
Krepych, S. Ya., & Spivak, I. Ya. (Eds.). (2020). Yakist prohramnoho zabezpechennia ta testu-vannia [Software quality and testing]. FOP Palianytsia V. A.
Gao, Y., et al. (2023). Retrieval-Augmented Generation for Large Language Models: A Survey (arXiv:2312.10997). arXiv. https://arxiv.org/abs/2312.10997
Lewis, P., et al. (2020). Retrieval-Augmented Generation for Knowledge-Intensive NLP Tasks. Advances in NeurIPS, 33, 9459–9474.
Sun, Z., et al. (2024). Retrieval-Augmented Test Generation: How Far Are We? (arXiv:2409.12682). arXiv. https://arxiv.org/abs/2409.12682
Sheffer, T. (2024). RAG for a Codebase with 10k Repos. Qodo Engineering Blog. https://www.qodo.ai/blog/rag-for-large-scale-code-repos
Anthropic. (2024). Introducing the Model Context Protocol. https://www.anthropic.com/news/model-context-protocol
Model Context Protocol. (2025). Wikipedia. https://en.wikipedia.org/wiki/Model_Context_Protocol
IBM. (2024). What is Model Context Protocol (MCP) https://www.ibm.com/think/topics/model-context-protocol
Завантаження
Опубліковано
Номер
Розділ
Ліцензія
Авторське право (c) 2026 Системні технології
Ця робота ліцензується відповідно до ліцензії Creative Commons Attribution 4.0 International License.
