Herramientas de usuario
ada:howto:sicoferp:factory:integrations:docjavadoc
Diferencias
Muestra las diferencias entre dos versiones de la página.
|
ada:howto:sicoferp:factory:integrations:docjavadoc [2022/03/22 13:15] administraidor creado |
ada:howto:sicoferp:factory:integrations:docjavadoc [2022/03/22 14:26] (actual) administraidor |
||
|---|---|---|---|
| Línea 1: | Línea 1: | ||
| - | ====== Fábrica - Servicios Web - Integraciones - Consultar Javadoc ====== | + | ====== Fábrica - Servicios Web - Integraciones - Consultar Documentación Javadoc ====== |
| - | Esta sección esta a la consulta de documentación javadoc generada por los microservicios. | + | Esta sección describe el proceso de consulta de la documentación Javadoc. La cual provee información tecnica relacionada con el servicio y su estrcutura de paquetes y clases. Esta documentación es conocida como documentación interna ya que ayuda a los desarrolladores a conocer el API. |
| - | ===== Consultar Javadoc ===== | + | ===== Consultar Documentación Javadoc ===== |
| === Pasos Previos === | === Pasos Previos === | ||
| - | * La generación del ejecutable dependerá de la configuración del POM el cual se define en la etiqueta <packaging> | + | * El usuario que consulte la documentación debe tener permisos de lectura en el repositorio SVN donde se aloje el contenido. |
| - | * Se asume que el lector tiene conocimeintos previos del uso del lenguaje Java e IDE (Eclipse, Spring Tools) | + | * La url de la documentación estará definida en el servicio, sin embargo casi siempre se genera en un directorio /doc a nivel del proyecto o en el directorio target/site/apidocs |
| - | ==== Generar compilado war ==== | + | ==== Visualizar la documentación en el navegador ==== |
| Siga los siguientes pasos: | Siga los siguientes pasos: | ||
| - | * Ubiquese en la raíz del proyecto (Carpeta principal con el nombre del proyecto), | + | * Descargue el directorio de la documentación desde el repositorio en su equipo local (Asegure que tiene permisos de lectura/escritura). |
| - | * Click derecho para visualizar un menu emerguente y seleccione la opción -> Run as... -> Maven builds... | + | * Abra el archivo index.html o copie la ruta del directorio descargado/index.html en un navegador web |
| - | * Aparece un formulario flotante. En la casilla **Goals** ingrese el comando: **clean install -DskipTests** para generar el war((Tambien puede utilizar en su lugar la instrucción **clean install** si desea ejecutar las pruebas unitarias.)) | + | |
| - | * Al finalizar el proceso si no hay errores se generará el war en el directorio target del proyecto. | + | |
| - | + | ||
| - | === Nota === | + | |
| - | Para ubicar el war en el directorio del equipo desde el proyecto seleccione el war con click derecho y vaya a propiedades al visualizar la ventana emergente se verá la ubicación del archivo. | + | |
| - | + | ||
| - | ==== Generar compilado jar ==== | + | |
| - | Siga los siguientes pasos: | + | |
| - | + | ||
| - | * Ubiquese en la raíz del proyecto (Carpeta principal con el nombre del proyecto), | + | |
| - | * Click derecho para visualizar un menu emerguente y seleccione la opción -> Run as... -> Maven builds... | + | |
| - | * Aparece un formulario flotante. En la casilla **Goals** ingrese el comando: **clean package -DskipTests** para generar el jar((Tambien puede utilizar en su lugar la instrucción **clean package** si desea ejecutar las pruebas unitarias.)) | + | |
| - | * Al finalizar el proceso si no hay errores se generará el jar en el directorio target del proyecto. | + | |
| - | + | ||
| - | === Nota === | + | |
| - | Para ubicar el jar en el directorio del equipo desde el proyecto seleccione el jar con click derecho y vaya a propiedades al visualizar la ventana emergente se verá la ubicación del archivo. | + | |
| - | + | ||
| - | + | ||
| - | ===== Despliegue war en servidor ===== | + | |
| - | + | ||
| - | === Pasos Previos === | + | |
| - | * Por lo general el war se genera con la estructura del POM y en la mayoria de los casos se genera el nombre de la siguiente forma **Nombre Servicio-0.0.1-SNAPSHOT.war** se recomienda modificar el nombre del archivo generado a **Nombre Servicio.war** ya que ese será el path base utilizado en el despliegue. | + | |
| - | * Se asume que el servidor para despliegue war es un servidor wildfly. | + | |
| - | + | ||
| - | Siga los siguientes pasos: | + | |
| - | + | ||
| - | - Acceder al servidor de despliegue por WSCP o SSH | + | |
| - | - Si existe un despliegue previo, borre el archivo **Nombre Servicio.war** y espere que el archivo de despliegue quede inválido (Haga caso omiso de este punto si es la primera vez). | + | |
| - | - Si existe un despliegue previo, borre el archivo de despliegue **Nombre Servicio.war**.undeploy (Haga caso omiso de este punto si es la primera vez). | + | |
| - | - Copie el nuevo war en la ruta de despliegue del servidor por lo general termina en **/standalone/deployments** se recomienda utilizar WSCP por su interfaz gráfica. Debe esperar mientras se sube el despliegue al servidor el cual terminará correctamente si se crea el archivo **Nombre Servicio.war**.deployed. Si falla este proceso debe ir al paso 2. | + | |
| - | - Por último desde un navegador ingrese la url **http://Ip servidor:Puerto/Nombre Servicio/** y debera visualizar el contenido inicial del servicio indicando que el despliegue fué realizado correctamente. | + | |
| - | + | ||
| - | ===== Despliegue jar en servidor ===== | + | |
| - | + | ||
| - | === Pasos Previos === | + | |
| - | * Por lo general el jar se genera con la estructura del POM y en la mayoria de los casos se genera el nombre de la siguiente forma **Nombre Servicio-0.0.1-SNAPSHOT.war** se recomienda modificar el nombre del archivo generado a **Nombre Servicio.jar** ya que ese será el path base utilizado en el despliegue. | + | |
| - | * Este método de despliegue contiene embebido su propio servidor web por lo tanto el puerto utilziado en el properties será el utilizado en el despliegue y debe asegurarse que está disponible. | + | |
| - | + | ||
| - | Siga los siguientes pasos: | + | |
| - | + | ||
| - | - Acceder al servidor de despliegue por WSCP o SSH | + | |
| - | - Si existe un despliegue previo debe identificar el proceso en ejecución con el comentado ps -aux | grep **Nombre Servicio.jar** y si existe se devolver un **identificador númerico**. | + | |
| - | - Si existe un despliegue previo ejecute el comando kill -**identificador númerico** para quitar el proceso. - | + | |
| - | - Borre el archivo **Nombre Servicio.jar** | + | |
| - | - Copie el nuevo jar en la ruta de despliegue del servidor. Se recomienda utilizar WSCP por su interfaz gráfica. | + | |
| - | - Ubiquese en la ruta donde copio el jar y ejecute el comando nohup java -jar **Nombre Servicio.jar** & | + | |
| - | - Por último desde un navegador ingrese la url **http://Ip servidor:Puerto Properties** y debera visualizar el contenido inicial del servicio indicando que el despliegue fué realizado correctamente. | + | |
| [[ada:howto:sicoferp:factory:integrations|←Volver atras]] | [[ada:howto:sicoferp:factory:integrations|←Volver atras]] | ||
ada/howto/sicoferp/factory/integrations/docjavadoc.1647954942.txt.gz · Última modificación: 2022/03/22 13:15 por administraidor
Herramientas de la página
