BirdTouch WebAPI

BirdTouch-Webapi

BirdTouch-Webapi es un servidor que es consumido por la aplicación BirdTouch Android.

El servidor está escrito en .NET 5.0 utilizando la base de datos PostgreSQL.

Requisitos

• Estibador
• Docker componer
• El puerto 4050 será gratuito y no utiliza ninguna aplicación en la máquina donde Docker Daemon se está ejecutando

Instalación

• Configurar el archivo .env (consulte la sección Configuración)
• Ejecute docker-compose up -d desde la raíz de este repositorio
• Ejecute docker-compose ps para verificar si todos los servicios están en funcionamiento
  • Nota: El servicio database-migration debe estar en Exit 0
• ¡Felicidades! Webapi (con base de datos) ya está disponible en el puerto 4050

Migración de base de datos [opcional] (actualización/nuevos scripts SQL)

Todos los scripts SQL utilizados para crear la base de datos e insertar los datos necesarios se encuentran en la carpeta de migraciones.

Para agregar nuevos scripts personalizados o ejecutar la actualización de la base de datos, siga el siguiente procedimiento:

1. Cree un nuevo script .sql después de la convención de nombres en la carpeta de migraciones: la idea es que los scripts están ordenados alfabéticamente para tener algún tipo de orden de ejecución.

2. Tenga en cuenta que los scripts que una vez se ejecutan no se ejecutarán nuevamente en la misma base de datos (para verificar si se ejecuta el script, se usa el nombre del script)

3. Cuando tenga todos los scripts necesarios ahora agregados a la carpeta de migraciones, ejecute:

   docker-compose up database-migration --build

Configuración

Toda la configuración se realiza editando el archivo .env.

• Cambios recomendados:

  • Actualice POSTGRES_PASSWORD y cadenas de conexión utilizadas para acceder a la base de datos.
  • Actualice la contraseña PGADMIN_DEFAULT_PASSWORD utilizada para acceder a la aplicación PGADmin.
  • Cambiar JWTSecurityKey que se utiliza para el hash de los tokens de autorización.

• Opcional:

  • RemoveInactiveUsersRunEvery Tarea programada que verifique si hay usuarios inactivos
  • RemoveInactiveUsersRemoveUsersOlderThan establece cuántas horas de inactividad se consideran para que el usuario esté en estado inactivo

Bueno saber detalles

Obtener la dirección IP del contenedor WSL2 Linux

Si está utilizando WSL2 en Windows10 y tiene un contenedor de Linux donde instaló Docker, para acceder a BirdTouch Webapi (por ejemplo, desde el cliente BirdTouch que se ejecuta en Android Emulator) debe descubrir la dirección IP de la sesión WSL2.

Haga el siguiente procedimiento:

1. Iniciar sesión en la máquina Linux con WSL2
2. Ejecutar ifconfig
3. Encuentre el valor net del eth0: por ejemplo, sería 172.22.200.173
4. Felicitaciones, ahora puede acceder a su Webapi BirdTouch que se ejecuta en WSL2 Linux Contenedor a través de 172.22.200.173:4050

Si desea servir Webapi de su PC

1. Compruebe si el puerto donde funciona Webapi (generalmente 4050) es accesible para el mundo:
2. Si no, ¡configúrelo para que sea! :)
3. [Opcional] Noip.com El sitio proporciona herramientas DUC que sincronizan su dirección IP dinámica con algún nombre de host, de esa manera, puede alojar cualquier cosa desde su PC local y no preocuparse por el cambio de la dirección IP