API - Instalación
- Marta Villar
- Pablo Carrallo de la Fuente (Unlicensed)
Í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: Download .NET 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: Download .NET 6.0 (Linux, macOS, and Windows)
Si se prefiere, se puede descargar en el enlace Download .NET 6.0 (Linux, macOS, and Windows) 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:/Grupo10En 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.