Biblioteca Maven para la generación automatizada de documentación de APIs REST desarrollados en Java y Spring Boot
Descripción del Articulo
El presente proyecto tiene como objetivo implementar una biblioteca Maven que pueda ser utilizada por la organización consultada para poder automatizar una de las tareas del proceso de desarrollo de software que elaboran cada uno de sus respectivos equipos. Esta automatización será capaz de poder ge...
Autores: | , |
---|---|
Formato: | tesis de grado |
Fecha de Publicación: | 2022 |
Institución: | Universidad Peruana de Ciencias Aplicadas |
Repositorio: | UPC-Institucional |
Lenguaje: | español |
OAI Identifier: | oai:repositorioacademico.upc.edu.pe:10757/661410 |
Enlace del recurso: | http://hdl.handle.net/10757/661410 |
Nivel de acceso: | acceso abierto |
Materia: | Java Microservicios Automatización Documentación Rest Api Spring http://purl.org/pe-repo/ocde/ford#2.00.00 https://purl.org/pe-repo/ocde/ford#2.02.04 |
id |
UUPC_d610db12f01db95b8347190ea182931d |
---|---|
oai_identifier_str |
oai:repositorioacademico.upc.edu.pe:10757/661410 |
network_acronym_str |
UUPC |
network_name_str |
UPC-Institucional |
repository_id_str |
2670 |
dc.title.es_PE.fl_str_mv |
Biblioteca Maven para la generación automatizada de documentación de APIs REST desarrollados en Java y Spring Boot |
dc.title.alternative.es_PE.fl_str_mv |
Maven library to generate automated REST API documentation of services using Java and Spring Boot |
title |
Biblioteca Maven para la generación automatizada de documentación de APIs REST desarrollados en Java y Spring Boot |
spellingShingle |
Biblioteca Maven para la generación automatizada de documentación de APIs REST desarrollados en Java y Spring Boot Aguilar Rojas, Carlos Rubén Java Microservicios Automatización Documentación Rest Api Spring http://purl.org/pe-repo/ocde/ford#2.00.00 https://purl.org/pe-repo/ocde/ford#2.02.04 |
title_short |
Biblioteca Maven para la generación automatizada de documentación de APIs REST desarrollados en Java y Spring Boot |
title_full |
Biblioteca Maven para la generación automatizada de documentación de APIs REST desarrollados en Java y Spring Boot |
title_fullStr |
Biblioteca Maven para la generación automatizada de documentación de APIs REST desarrollados en Java y Spring Boot |
title_full_unstemmed |
Biblioteca Maven para la generación automatizada de documentación de APIs REST desarrollados en Java y Spring Boot |
title_sort |
Biblioteca Maven para la generación automatizada de documentación de APIs REST desarrollados en Java y Spring Boot |
author |
Aguilar Rojas, Carlos Rubén |
author_facet |
Aguilar Rojas, Carlos Rubén Vega Balbín, Antonny Giancarlo |
author_role |
author |
author2 |
Vega Balbín, Antonny Giancarlo |
author2_role |
author |
dc.contributor.advisor.fl_str_mv |
Barrientos Padilla, Alfredo |
dc.contributor.author.fl_str_mv |
Aguilar Rojas, Carlos Rubén Vega Balbín, Antonny Giancarlo |
dc.subject.es_PE.fl_str_mv |
Java Microservicios Automatización Documentación Rest Api Spring |
topic |
Java Microservicios Automatización Documentación Rest Api Spring http://purl.org/pe-repo/ocde/ford#2.00.00 https://purl.org/pe-repo/ocde/ford#2.02.04 |
dc.subject.ocde.es_PE.fl_str_mv |
http://purl.org/pe-repo/ocde/ford#2.00.00 https://purl.org/pe-repo/ocde/ford#2.02.04 |
description |
El presente proyecto tiene como objetivo implementar una biblioteca Maven que pueda ser utilizada por la organización consultada para poder automatizar una de las tareas del proceso de desarrollo de software que elaboran cada uno de sus respectivos equipos. Esta automatización será capaz de poder generar la documentación de los servicios REST java desarrollados por la compañía de manera automática, logrando así reducir los tiempos requeridos en el proceso mencionado, los cuales logran diferentes beneficios, entre ellos el económico. Para la realización de este proyecto, se investigaron las diferentes razones por la cual la documentación técnica es muchas veces ineficiente o inexistente, con ellos se logró dar un mejor enfoque a la solución a plantear, de manera que se pueda maximizar el beneficio del mismo. Además, para el proyecto de implementación se analizó la metodología óptima para su desarrollo, así como el lenguaje de programación y las diferentes especialidades que conformarían al equipo. La solución planteada requiere de un conjunto de herramientas para que pueda ser aprovechado de la mejor manera, entre ellos a Jenkins para la integración continua, Bitbucket para almacenar y versionar el código fuente, Artifactory para almacenar los artefactos generados. Todos estos han sido validados por la organización consultada. |
publishDate |
2022 |
dc.date.accessioned.none.fl_str_mv |
2022-10-18T20:46:19Z |
dc.date.available.none.fl_str_mv |
2022-10-18T20:46:19Z |
dc.date.issued.fl_str_mv |
2022-05-30 |
dc.type.es_PE.fl_str_mv |
info:eu-repo/semantics/bachelorThesis |
dc.type.other.es_PE.fl_str_mv |
Tesis |
dc.type.coar.es_PE.fl_str_mv |
http://purl.org/coar/resource_type/c_7a1f |
format |
bachelorThesis |
dc.identifier.uri.none.fl_str_mv |
http://hdl.handle.net/10757/661410 |
dc.identifier.isni.none.fl_str_mv |
0000 0001 2196 144X |
url |
http://hdl.handle.net/10757/661410 |
identifier_str_mv |
0000 0001 2196 144X |
dc.language.iso.es_PE.fl_str_mv |
spa |
language |
spa |
dc.relation.ispartof.fl_str_mv |
SUNEDU |
dc.rights.es_PE.fl_str_mv |
info:eu-repo/semantics/openAccess |
dc.rights.uri.*.fl_str_mv |
http://creativecommons.org/licenses/by-nc-sa/4.0/ |
dc.rights.coar.es_PE.fl_str_mv |
http://purl.org/coar/access_right/c_abf2 |
eu_rights_str_mv |
openAccess |
rights_invalid_str_mv |
http://creativecommons.org/licenses/by-nc-sa/4.0/ http://purl.org/coar/access_right/c_abf2 |
dc.format.es_PE.fl_str_mv |
application/pdf application/epub application/msword |
dc.publisher.es_PE.fl_str_mv |
Universidad Peruana de Ciencias Aplicadas (UPC) |
dc.publisher.country.es_PE.fl_str_mv |
PE |
dc.source.es_PE.fl_str_mv |
Repositorio Académico - UPC Universidad Peruana de Ciencias Aplicadas (UPC) |
dc.source.none.fl_str_mv |
reponame:UPC-Institucional instname:Universidad Peruana de Ciencias Aplicadas instacron:UPC |
instname_str |
Universidad Peruana de Ciencias Aplicadas |
instacron_str |
UPC |
institution |
UPC |
reponame_str |
UPC-Institucional |
collection |
UPC-Institucional |
bitstream.url.fl_str_mv |
https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/8/Aguilar_RC.pdf https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/7/Aguilar_RC.pdf.jpg https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/10/Aguilar_RC_Ficha.pdf.jpg https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/6/Aguilar_RC.pdf.txt https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/9/Aguilar_RC_Ficha.pdf.txt https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/3/Aguilar_RC.pdf https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/4/Aguilar_RC.docx https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/5/Aguilar_RC_Ficha.pdf https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/2/license.txt https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/1/license_rdf |
bitstream.checksum.fl_str_mv |
41cdad1c219f51968e9c16936735947f b6d71b4409578bded9583ba6414db1be 61d1bf4f174711367045f63e364583a9 c15e441f9bf3ae3c6ae7287e1f3f81f3 4b687e869ecbcb0ceb1d98ace807d911 3be26ac6404195ec97a763ae55f12b49 4412f912208b7a604e780ccda37c3ca3 a1340ed3110221f92642f23b6b8b79ea 8a4605be74aa9ea9d79846c1fba20a33 934f4ca17e109e0a05eaeaba504d7ce4 |
bitstream.checksumAlgorithm.fl_str_mv |
MD5 MD5 MD5 MD5 MD5 MD5 MD5 MD5 MD5 MD5 |
repository.name.fl_str_mv |
Repositorio académico upc |
repository.mail.fl_str_mv |
upc@openrepository.com |
_version_ |
1839090676214530048 |
spelling |
8ae1895e11d12e88f0231b0229dfc37f500Barrientos Padilla, Alfredoaa5b74d12a1bc8b1b7f69a30cc54928150096d15c67010ec431da436da10d3f9866500Aguilar Rojas, Carlos RubénVega Balbín, Antonny Giancarlo2022-10-18T20:46:19Z2022-10-18T20:46:19Z2022-05-30http://hdl.handle.net/10757/6614100000 0001 2196 144XEl presente proyecto tiene como objetivo implementar una biblioteca Maven que pueda ser utilizada por la organización consultada para poder automatizar una de las tareas del proceso de desarrollo de software que elaboran cada uno de sus respectivos equipos. Esta automatización será capaz de poder generar la documentación de los servicios REST java desarrollados por la compañía de manera automática, logrando así reducir los tiempos requeridos en el proceso mencionado, los cuales logran diferentes beneficios, entre ellos el económico. Para la realización de este proyecto, se investigaron las diferentes razones por la cual la documentación técnica es muchas veces ineficiente o inexistente, con ellos se logró dar un mejor enfoque a la solución a plantear, de manera que se pueda maximizar el beneficio del mismo. Además, para el proyecto de implementación se analizó la metodología óptima para su desarrollo, así como el lenguaje de programación y las diferentes especialidades que conformarían al equipo. La solución planteada requiere de un conjunto de herramientas para que pueda ser aprovechado de la mejor manera, entre ellos a Jenkins para la integración continua, Bitbucket para almacenar y versionar el código fuente, Artifactory para almacenar los artefactos generados. Todos estos han sido validados por la organización consultada.The objective of this project is to implement a Maven library that can be used by the consulted organization to be able to automate one of the tasks of the software development process that each of their respective teams elaborates. This automation will be able to generate the documentation of the java REST services developed by the company automatically, thus reducing the time required in the process, which achieves different benefits, including an economic one. For the realization of this project, the different reasons why the technical documentation is often inefficient or non-existent were investigated, with them it was possible to give a better approach to the solution to be proposed, so that its benefit can be maximized. In addition, for the implementation project, the optimal methodology for its development was analyzed, as well as the programming language and the different specialties that the team would require. The proposed solution requires a set of tools so that it can be used in the best way, including Jenkins for continuous integration, Bitbucket for storage and source code versioning, and Artifactory to store the generated artifacts. All of these have been validated by the consulted organization.Tesisapplication/pdfapplication/epubapplication/mswordspaUniversidad Peruana de Ciencias Aplicadas (UPC)PEinfo:eu-repo/semantics/openAccesshttp://creativecommons.org/licenses/by-nc-sa/4.0/http://purl.org/coar/access_right/c_abf2Repositorio Académico - UPCUniversidad Peruana de Ciencias Aplicadas (UPC)reponame:UPC-Institucionalinstname:Universidad Peruana de Ciencias Aplicadasinstacron:UPCJavaMicroserviciosAutomatizaciónDocumentaciónRestApiSpringhttp://purl.org/pe-repo/ocde/ford#2.00.00https://purl.org/pe-repo/ocde/ford#2.02.04Biblioteca Maven para la generación automatizada de documentación de APIs REST desarrollados en Java y Spring BootMaven library to generate automated REST API documentation of services using Java and Spring Bootinfo:eu-repo/semantics/bachelorThesisTesishttp://purl.org/coar/resource_type/c_7a1fSUNEDUUniversidad Peruana de Ciencias Aplicadas (UPC). Facultad de IngenieríaLicenciaturaIngeniería de SoftwareIngeniero de Software2022-10-21T00:26:46Zhttps://purl.org/pe-repo/renati/type#tesishttps://orcid.org/0000-0002-0029-4913https://purl.org/pe-repo/renati/level#tituloProfesional612236CONVERTED2_37866412092-10-20Aguilar_RC.pdfAguilar_RC.pdfapplication/pdf1342922https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/8/Aguilar_RC.pdf41cdad1c219f51968e9c16936735947fMD58falseTHUMBNAILAguilar_RC.pdf.jpgAguilar_RC.pdf.jpgGenerated Thumbnailimage/jpeg27782https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/7/Aguilar_RC.pdf.jpgb6d71b4409578bded9583ba6414db1beMD57false2092-10-20Aguilar_RC_Ficha.pdf.jpgAguilar_RC_Ficha.pdf.jpgGenerated Thumbnailimage/jpeg34417https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/10/Aguilar_RC_Ficha.pdf.jpg61d1bf4f174711367045f63e364583a9MD510falseTEXTAguilar_RC.pdf.txtAguilar_RC.pdf.txtExtracted texttext/plain155192https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/6/Aguilar_RC.pdf.txtc15e441f9bf3ae3c6ae7287e1f3f81f3MD56false2092-10-20Aguilar_RC_Ficha.pdf.txtAguilar_RC_Ficha.pdf.txtExtracted texttext/plain4https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/9/Aguilar_RC_Ficha.pdf.txt4b687e869ecbcb0ceb1d98ace807d911MD59falseORIGINALAguilar_RC.pdfAguilar_RC.pdfapplication/pdf1886586https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/3/Aguilar_RC.pdf3be26ac6404195ec97a763ae55f12b49MD53true2092-10-20Aguilar_RC.docxAguilar_RC.docxapplication/vnd.openxmlformats-officedocument.wordprocessingml.document1396348https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/4/Aguilar_RC.docx4412f912208b7a604e780ccda37c3ca3MD54false2092-10-20Aguilar_RC_Ficha.pdfAguilar_RC_Ficha.pdfapplication/pdf1720618https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/5/Aguilar_RC_Ficha.pdfa1340ed3110221f92642f23b6b8b79eaMD55falseLICENSElicense.txtlicense.txttext/plain; charset=utf-81748https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/2/license.txt8a4605be74aa9ea9d79846c1fba20a33MD52falseCC-LICENSElicense_rdflicense_rdfapplication/rdf+xml; charset=utf-81031https://repositorioacademico.upc.edu.pe/bitstream/10757/661410/1/license_rdf934f4ca17e109e0a05eaeaba504d7ce4MD51false10757/661410oai:repositorioacademico.upc.edu.pe:10757/6614102025-07-20 19:03:28.534Repositorio académico upcupc@openrepository.comTk9URTogUExBQ0UgWU9VUiBPV04gTElDRU5TRSBIRVJFClRoaXMgc2FtcGxlIGxpY2Vuc2UgaXMgcHJvdmlkZWQgZm9yIGluZm9ybWF0aW9uYWwgcHVycG9zZXMgb25seS4KCk5PTi1FWENMVVNJVkUgRElTVFJJQlVUSU9OIExJQ0VOU0UKCkJ5IHNpZ25pbmcgYW5kIHN1Ym1pdHRpbmcgdGhpcyBsaWNlbnNlLCB5b3UgKHRoZSBhdXRob3Iocykgb3IgY29weXJpZ2h0Cm93bmVyKSBncmFudHMgdG8gRFNwYWNlIFVuaXZlcnNpdHkgKERTVSkgdGhlIG5vbi1leGNsdXNpdmUgcmlnaHQgdG8gcmVwcm9kdWNlLAp0cmFuc2xhdGUgKGFzIGRlZmluZWQgYmVsb3cpLCBhbmQvb3IgZGlzdHJpYnV0ZSB5b3VyIHN1Ym1pc3Npb24gKGluY2x1ZGluZwp0aGUgYWJzdHJhY3QpIHdvcmxkd2lkZSBpbiBwcmludCBhbmQgZWxlY3Ryb25pYyBmb3JtYXQgYW5kIGluIGFueSBtZWRpdW0sCmluY2x1ZGluZyBidXQgbm90IGxpbWl0ZWQgdG8gYXVkaW8gb3IgdmlkZW8uCgpZb3UgYWdyZWUgdGhhdCBEU1UgbWF5LCB3aXRob3V0IGNoYW5naW5nIHRoZSBjb250ZW50LCB0cmFuc2xhdGUgdGhlCnN1Ym1pc3Npb24gdG8gYW55IG1lZGl1bSBvciBmb3JtYXQgZm9yIHRoZSBwdXJwb3NlIG9mIHByZXNlcnZhdGlvbi4KCllvdSBhbHNvIGFncmVlIHRoYXQgRFNVIG1heSBrZWVwIG1vcmUgdGhhbiBvbmUgY29weSBvZiB0aGlzIHN1Ym1pc3Npb24gZm9yCnB1cnBvc2VzIG9mIHNlY3VyaXR5LCBiYWNrLXVwIGFuZCBwcmVzZXJ2YXRpb24uCgpZb3UgcmVwcmVzZW50IHRoYXQgdGhlIHN1Ym1pc3Npb24gaXMgeW91ciBvcmlnaW5hbCB3b3JrLCBhbmQgdGhhdCB5b3UgaGF2ZQp0aGUgcmlnaHQgdG8gZ3JhbnQgdGhlIHJpZ2h0cyBjb250YWluZWQgaW4gdGhpcyBsaWNlbnNlLiBZb3UgYWxzbyByZXByZXNlbnQKdGhhdCB5b3VyIHN1Ym1pc3Npb24gZG9lcyBub3QsIHRvIHRoZSBiZXN0IG9mIHlvdXIga25vd2xlZGdlLCBpbmZyaW5nZSB1cG9uCmFueW9uZSdzIGNvcHlyaWdodC4KCklmIHRoZSBzdWJtaXNzaW9uIGNvbnRhaW5zIG1hdGVyaWFsIGZvciB3aGljaCB5b3UgZG8gbm90IGhvbGQgY29weXJpZ2h0LAp5b3UgcmVwcmVzZW50IHRoYXQgeW91IGhhdmUgb2J0YWluZWQgdGhlIHVucmVzdHJpY3RlZCBwZXJtaXNzaW9uIG9mIHRoZQpjb3B5cmlnaHQgb3duZXIgdG8gZ3JhbnQgRFNVIHRoZSByaWdodHMgcmVxdWlyZWQgYnkgdGhpcyBsaWNlbnNlLCBhbmQgdGhhdApzdWNoIHRoaXJkLXBhcnR5IG93bmVkIG1hdGVyaWFsIGlzIGNsZWFybHkgaWRlbnRpZmllZCBhbmQgYWNrbm93bGVkZ2VkCndpdGhpbiB0aGUgdGV4dCBvciBjb250ZW50IG9mIHRoZSBzdWJtaXNzaW9uLgoKSUYgVEhFIFNVQk1JU1NJT04gSVMgQkFTRUQgVVBPTiBXT1JLIFRIQVQgSEFTIEJFRU4gU1BPTlNPUkVEIE9SIFNVUFBPUlRFRApCWSBBTiBBR0VOQ1kgT1IgT1JHQU5JWkFUSU9OIE9USEVSIFRIQU4gRFNVLCBZT1UgUkVQUkVTRU5UIFRIQVQgWU9VIEhBVkUKRlVMRklMTEVEIEFOWSBSSUdIVCBPRiBSRVZJRVcgT1IgT1RIRVIgT0JMSUdBVElPTlMgUkVRVUlSRUQgQlkgU1VDSApDT05UUkFDVCBPUiBBR1JFRU1FTlQuCgpEU1Ugd2lsbCBjbGVhcmx5IGlkZW50aWZ5IHlvdXIgbmFtZShzKSBhcyB0aGUgYXV0aG9yKHMpIG9yIG93bmVyKHMpIG9mIHRoZQpzdWJtaXNzaW9uLCBhbmQgd2lsbCBub3QgbWFrZSBhbnkgYWx0ZXJhdGlvbiwgb3RoZXIgdGhhbiBhcyBhbGxvd2VkIGJ5IHRoaXMKbGljZW5zZSwgdG8geW91ciBzdWJtaXNzaW9uLgo= |
score |
13.049697 |
Nota importante:
La información contenida en este registro es de entera responsabilidad de la institución que gestiona el repositorio institucional donde esta contenido este documento o set de datos. El CONCYTEC no se hace responsable por los contenidos (publicaciones y/o datos) accesibles a través del Repositorio Nacional Digital de Ciencia, Tecnología e Innovación de Acceso Abierto (ALICIA).
La información contenida en este registro es de entera responsabilidad de la institución que gestiona el repositorio institucional donde esta contenido este documento o set de datos. El CONCYTEC no se hace responsable por los contenidos (publicaciones y/o datos) accesibles a través del Repositorio Nacional Digital de Ciencia, Tecnología e Innovación de Acceso Abierto (ALICIA).