DSpace Repository

Domain specific language for creating API documentation

Show simple item record

dc.contributor FIȘTIC, Cristofor
dc.contributor.author MARTÎNIUC, Artiom
dc.contributor.author MUSIN, Vladislava
dc.contributor.author OSTAFI, Eugen
dc.contributor.author POPA, Marius
dc.contributor.author POPOV, Nichista
dc.date.accessioned 2024-10-23T08:28:09Z
dc.date.available 2024-10-23T08:28:09Z
dc.date.issued 2024
dc.identifier.citation MARTÎNIUC, Artiom; Vladislava MUSIN; Eugen OSTAFI; Marius POPA and Nichista POPOV. Domain specific language for creating API documentation. In: Conferinţa tehnico-ştiinţifică a studenţilor, masteranzilor şi doctoranzilor = Technical Scientific Conference of Undergraduate, Master and PhD Students, Universitatea Tehnică a Moldovei, 27-29 martie 2024. Chișinău, 2024, vol. 2, pp. 907-910. ISBN 978-9975-64-458-7, ISBN 978 9975-64-460-0 (Vol.2). en_US
dc.identifier.isbn 978-9975-64-458-7
dc.identifier.isbn 978 9975-64-460-0
dc.identifier.uri http://repository.utm.md/handle/5014/28258
dc.description.abstract This article introduces a Domain-Specific Language (DSL) designed for the management and display of API documentation, aiming to ease the documentation process and enhance the quality of API guides. The common approach to documenting APIs often involves manual processes that are time-consuming and vastly different across different sources, because of the variety in either company practice or industry standards. The proposed DSL addresses these challenges by offering a structured, simple format to understand the complexities involved in describing API endpoints, parameters, request and response models, and perhaps even examples of such use. The main goal of this work lies in understanding and getting rid of the struggles developers face when having to deal with new API documentation. The specific aim of the DSL is to allow for quick adaptation by developers and technical writers without requiring extensive, dreadful research and understanding of the different interfaces and classifications of various sources. By combining theoretical design principles and practical implementation strategies, this work aims to demonstrate the effectiveness of using a DSL for API documentation. It will provide a comprehensive solution that will reduce the effort needed for using and understanding API documentation, by making it more consistent and accurate, therefore enhancing developer experience when having to use APIs. en_US
dc.language.iso en en_US
dc.publisher Universitatea Tehnică a Moldovei en_US
dc.relation.ispartofseries Conferinţa tehnico-ştiinţifică a studenţilor, masteranzilor şi doctoranzilor = Technical Scientific Conference of Undergraduate, Master and PhD Students: Chişinău, 27-29 martie 2024. Vol. 2;
dc.rights Attribution-NonCommercial-NoDerivs 3.0 United States *
dc.rights.uri http://creativecommons.org/licenses/by-nc-nd/3.0/us/ *
dc.subject quality en_US
dc.subject documentation en_US
dc.subject application programming en_US
dc.subject domain-specific language en_US
dc.title Domain specific language for creating API documentation en_US
dc.type Article en_US


Files in this item

The following license files are associated with this item:

This item appears in the following Collection(s)

Show simple item record

Attribution-NonCommercial-NoDerivs 3.0 United States Except where otherwise noted, this item's license is described as Attribution-NonCommercial-NoDerivs 3.0 United States

Search DSpace


Advanced Search

Browse

My Account