Documentación automática de API basadas en peticiones SOAP

Abstract

[ES] Una API (Interfaz de Programación de Aplicaciones) es una pieza de código que permite a diferentes aplicaciones comunicarse entre sí y compartir información y funcionalidades. Es conveniente que los métodos expuestos por esta API estén documentados, preferiblemente con peticiones detalladas que se ofrezcan como ejemplo. El objetivo de este TFG es facilitar las tareas de documentación de la API, automatizando en parte dichas tareas mediante una aplicación que accederá a la información necesaria para completar la documentación de las peticiones. Este trabajo se ha desarrollado en el marco de una práctica de empresa, en el departamento de desarrollo donde se realiza el mantenimiento de su producto, un ERP para el sector sociosanitario, con una API que acepta peticiones SOAP.

[EN] An API (Application Programming Interface) is a piece of code that allows different applications to communicate with each other and share information and functionality. It is desirable that the methods exposed by this API be documented, preferably with detailed requests provided as examples. The objective of this TFG is to facilitate API documentation tasks, partly automating these tasks through an application that will access the information necessary to complete the documentation of the requests. This work has been developed within the framework of a company practice, in the development department where the maintenance of its product is carried out, an ERP for the social and healthcare sector, with an API that accepts SOAP requests.