¡Esta es una revisión vieja del documento!
Esta sección describe la plantilla para la documentación de los servicios web.
En esta zona se debe diligenciar la tabla de información relacionada con el servicio. A continuación se describen las columna definidas.
Nombre | Descripción | Tipo Servicio | Tecnología | Lenguaje | Tipo Desarrollo | Versión Desarrollo | Archivo de Configuración |
---|---|---|---|---|---|---|---|
Nombre del Servicio | Descripción del Servicio. | Tipo de Servicio [Rest, SOAP] | Framework utilizado en la construcción del servicio | Lenguaje de programación utilizado para la construccción del servico | Tipo de desarrollo de la solución: [Nuevo,Legado] | Versión del desarrollo | application.properties |
Tipo Empaquetado | Gestor de Dependencias | Servidor de Despliegue | IDE Proyecto | Tipo Repositorio | Url Desarrollo | Url Calidad | Url Producción |
jar | Maven 3.8.1 | Tomcat 6 | Eclipse 2021-03 | Subversión | SVN branches | SVN trunk | SVN tags |
Dependencias | |||||||
groupId | artifactId | version | scope | optional | Descripción | ||
org.springframework.boot | spring-boot-starter-data-jpa | N/A | N/A | N/A | API de persistencia | ||
org.springframework.boot | spring-boot-starter-thymeleaf | N/A | N/A | N/A | Motor de plantillas | ||
org.springframework.boot | spring-boot-starter-validation | N/A | N/A | N/A | Validador de información | ||
org.springframework.boot | spring-boot-starter-web | N/A | N/A | N/A | Core Servicios Web | ||
org.springframework.boot | spring-boot-devtools | N/A | runtime | true | Recarga de aplicaciones | ||
mysql | mysql-connector-java | N/A | runtime | N/A | Driver DB MySQL | ||
org.projectlombok | lombok | N/A | N/A | true | API de anotaciones para reducción de código | ||
org.springframework.boot | spring-boot-starter-test | N/A | test | N/A | Core Springboot | ||
org.apache.poi | poi | 3.15 | N/A | N/A | API de lectura de archivos Excel | ||
org.apache.poi | poi-ooxml | 3.15 | N/A | N/A | API de lectura de archivos Excel XML | ||
org.springframework.boot | spring-boot-starter-data-jdbc | N/A | N/A | N/A | API JDBC para conexión a Base de Datos | ||
com.microsoft.sqlserver | mssql-jdbc | N/A | runtime | N/A | Driver DB SQL Server | ||
org.apache.tomcat.embed | tomcat-embed-jasper | N/A | provided | N/A | Servidor embebido tomcat | ||
org.springframework.boot | spring-boot-starter-tomcat | N/A | provided | N/A | Core Spring | ||
org.apache.maven.plugins | maven-compiler-plugin | 3.8.1 | N/A | N/A | Gestor de dependnecias | ||
io.springfox | springfox-swagger2 | 2.9.2 | N/A | N/A | Core Documentación Web Services RESTful | ||
io.springfox | springfox-swagger-ui | 2.9.2 | N/A | N/A | GUI Documentación Web Services RESTful | ||
Operaciones | |||||||
Tipo Petición Http | Nombre operación | Descripción | Documentación | ||||
POST | cargarArchivo | Se encarga de procesar e insertar la información de un archivo excel en la tabla dbo.Tbl_Carga_Archivo | |||||
Ambientes de Despliegue | |||||||
Tipo | Url | Observaciones | |||||
Desarrollo | http://10.1.140.1:2690 | Ambiente de desarrollo | |||||
Calidad | Ambiente de validación | ||||||
Producción | Ambiente de producción |
Esta zona se define con el fin de adicionar información complementaria al servicio (si es requerido).