API - InstalaciĆ³n
Ćndice
IntroducciĆ³n
En este documento se detallan los pasos a seguir para la correcta instalaciĆ³n tanto de la API cĆ³mo del servicio de actualizaciĆ³n automĆ”tica de versiones.
Antes de comenzar, nos vamos a asegurar que desde Grupo 10 hemos recibido la entrega .zip con todo lo necesario para la instalaciĆ³n tanto de la API como del servicio de actualizaciĆ³n:
Carpeta āAPIApigesā: Contiene todos los archivos necesarios para la instalaciĆ³n de la API.
Carpeta āUpdateServiceā: Contiene todos los archivos necesarios para la instalaciĆ³n del servicio automĆ”tico de actualizaciones.
ActualizarApiges.sql: Script de actualizaciĆ³n de la base de datos.
Nota: Si no hay ningĆŗn cambio adicional en la versiĆ³n, no se adjuntarĆ” dicho script ya que es suficiente con la Ćŗltima versiĆ³n de Apiges.
Una vez recibidos los ficheros, comenzamos:
Es importante tener instalada las siguientes librerĆas para la correcta instalaciĆ³n de los servicios:
.NET Runtime para (x86) y (x64). Se puede comprobar si existe la carpeta C:/Archivos de programa (x86)/dotnet
En caso de no existir, puedes descargarla desde el siguiente enlace: https://dotnet.microsoft.com/en-us/download/dotnet/6.0/runtime . Apartado: Run console apps > Download x86 y Download x64
ASP.NET Core Runtime 6.0.3 para (x64). Se puede comprobar si existe dentro de la carpeta C:/Archivos de programa/dotnet
En caso de no existir, puedes descargarla desde el siguiente enlace: https://dotnet.microsoft.com/en-us/download/dotnet/6.0
Si se prefiere, se puede descargar en el enlace https://dotnet.microsoft.com/en-us/download/dotnet/6.0 el SDK 6.0.201 que contiene ambos runtimes
InstalaciĆ³n API
1.- En primer lugar, vamos a copiar la carpeta āAPIApigesā en la siguiente ruta:
C:/Grupo10
En caso de descomprimir el fichero en otra ruta, se deberĆ” modificar el ejecutable Install_Service.bat, con un editor de texto, para cambiar la ruta.
Importante: debes tener permisos de lectura y escritura sobre la nueva ruta.
Dentro de la carpeta āAPIApigesā, obtendremos la siguiente estructura de ficheros:
Ā
Carpeta āCertificadosā: En esta carpeta se tienen que almacenar los certificados en caso de utilizar protocolo HTTPs (seguro).
Carpeta āEjecutablesā: En esta carpeta se encuentran cuatro archivos .bat (instalaciĆ³n, arranque, parada y desinstalaciĆ³n del servicio).
Apiges.API.exe: Ejecutable que contiene la API y la versiĆ³n actual (en este ejemplo, 1.0.0.0).
Apiges.API.xml: Documento XML requerido para la documentaciĆ³n de Swagger.
appsettings.json: Fichero JSON de configuraciĆ³n del API. Este es el fichero que vamos a modificar para la instalaciĆ³n.
web.config: Fichero interno de configuraciĆ³n.
2.- Abrimos el fichero appsettings.json con un editor de texto:
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
}
},
"AllowedHosts": "*",
"ConnectionStrings": {
"Apiges": "Server=<server>;Database=Apiges;User Id=UserAdminG10;Password=Z42rm08;TrustServerCertificate=True"
},
"Kestrel": {
"URLs": "<protocolo>://<dominio>:<puerto>",
"Certificate": {
"Path": "<name>",
"Password": "<password>"
}
},
"JWT": {
"ApiKey": "IE38ru2I394U",
"Issuer": "",
"Audience": "",
"Id_Contacto": -1
},
"Pagination": {
"DefaultPageSize": 10,
"DefaultPageNumber": 1
},
"Language": {
"DefaultLanguage": "es"
}
}
Ejemplo de fichero appsettings.json tras sustituir los parƔmetros:
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
}
},
"AllowedHosts": "*",
"ConnectionStrings": {
"Apiges": "Server=LAPTOP-0232344AA4\\GRUPO10;Database=Apiges;User Id=UserAdminG10;Password=Z42rm08;TrustServerCertificate=True"
},
"Kestrel": {
"URLs": "https://192.168.45.63:8035",
"Certificate": {
"Path": "Prueba.pfx",
"Password": "admin"
}
},
"JWT": {
"ApiKey": "IE38ru2I394U",
"Issuer": "",
"Audience": "",
"Id_Contacto": -1
},
"Pagination": {
"DefaultPageSize": 10,
"DefaultPageNumber": 1
},
"Language": {
"DefaultLanguage": "es"
}
}
ConnectionStrings: En este bloque vamos a modificar los siguientes parĆ”metros para la conexiĆ³n a la base de datos:
ParĆ”metro | DescripciĆ³n | Obligatorio | Ejemplo |
<server> | Nombre del servidor de base de datos | SĆ | LAPTOP-0232344AA4\\GRUPO10 |
Kestrel:
En el bloque āURLsā vamos a configurar el dominio, protocolo y puerto en el que queremos desplegar la API.
ParĆ”metro | DescripciĆ³n | Obligatorio | Ejemplo |
<protocolo> | Protocolo de transferencia a utilizar | SĆ | http Ć³ https |
<dominio> | IP del servidor o de la mĆ”quina | SĆ | 192.168.45.63 |
<puerto> | Puerto API | SĆ | 8080 |
En caso de que el protocolo elegido sea https (seguro), se debe configurar el bloque āCertificateā.
ParĆ”metro | DescripciĆ³n | Obligatorio | Ejemplo |
<name> | Nombre del certificado a utilizar | SĆ al elegir https | Prueba.pfx |
<password> | ContraseƱa del certificado | SĆ al elegir https | admin |
Otros parƔmetros que se pueden modificar:
Dentro del bloque āLoggingā se puede cambiar la configuraciĆ³n por defecto para volcar mĆ”s o menos informaciĆ³n al fichero de log.
Dentro del bloque de āPaginationā se puede establecer el nĆŗmero y la pĆ”gina a mostrar para las bĆŗsquedas.
Dentro del bloque āLanguageā se puede modificar el idioma por defecto que se va a utilizar en las peticiones.
3.- Guardar los cambios de la configuraciĆ³n.
4.- Entramos dentro de la carpeta āEjecutablesā y ejecutamos el archivo āInstall_Serviceā con botĆ³n derecho āEjecutar como administradorā:
5.- Comprobaciones:
Comprobar que no ha dado ningĆŗn error en la salida al ejecutar el .bat.
En caso de error, comprobar el Visor de Eventos de Windows para mĆ”s informaciĆ³n.
Comprobar que el servicio estĆ” correctamente arrancado en los servicios de Windows.
Comprobar si estĆ” la API desplegada en la ruta:
InstalaciĆ³n servicio actualizaciĆ³n
Vamos a repetir los pasos anteriores pero, en este caso, con el servicio de actualizaciĆ³n automĆ”tica.
1.- En primer lugar, vamos a copiar la carpeta āUpdateServiceā en la siguiente ruta recomendada:
Dentro de la carpeta āUpdateServiceā, obtendremos la siguiente estructura de ficheros:
Ā
Carpeta āEjecutablesā: En esta carpeta se encuentran cuatro archivos .bat (instalaciĆ³n, arranque, parada y desinstalaciĆ³n del servicio).
Apiges.UpdateService.exe: Ejecutable que contiene el servicio de actualizaciĆ³n.
appsettings.json: Fichero JSON de configuraciĆ³n del servicio de actualizaciĆ³n.
En este caso, no vamos a necesitar modificar el fichero de configuraciĆ³n, ya que desde Grupo 10 ya lo enviamos personalizado para cada cliente.
2.- Entramos dentro de la carpeta āEjecutablesā y ejecutamos el archivo āInstall_Serviceā con botĆ³n derecho āEjecutar como administradorā:
3.- Comprobaciones:
Comprobar que no ha dado ningĆŗn error en la salida al ejecutar el .bat
En caso de error, comprobar el Visor de Eventos de Windows para mĆ”s informaciĆ³n.
Comprobar que el servicio estĆ” correctamente arrancado en los servicios de Windows.