Cl.Solution.Web.App 1.0.0

Acerca de la plantilla

Plantilla para crear una aplicación web con .NET Core 6 orientada a REST.

¿Qué resuelve?

En cada implementación desde cero, se suelen hacer una serie de pasos que son de carácter repetitivo.
A pesar de ser pasos ya conocidos, suelen haber variantes de implementación tras implementación,
lo que hace que los proyectos tengan estructuras diferentes pero siempre tratando de acoger la misma idea.

¿Cómo lo resuelve?

Mediante un proyecto listo para usarse, el cual contenga una serie de configuraciones predeterminadas que nos permitan
desentendernos de estas configuraciones iniciales y así aprovechar los recursos disponibles de mejor manera.

Contenido de la plantilla Web API

• Dos controladores que representan el acceso a SAP y a la base de datos de la aplicación.
• Contexto de base de datos de aplicación configurado con modelos básicos.
• Autenticación mediante JWT.
• Swagger UI implementados con uso de headers
• Ambientes de development, staging y production configurados.
• Perfiles de development, staging y production configurados.
• Servicios de Process y LogManager registrados.
• Archivo bitbucket-pipelines.yml preconfigurado con los ambientes clv_development, clv_staging, clv_master.
• Carpeta .vscode con los ambientes clv_development, clv_staging, clv_master preconfigurdos

Nugets usados

• Cl.Core.Common
• Cl.Core.Structures
• Cl.Core.Db
• Cl.Core.Sl

Configuraciones disponibles Web API

• Agregar propidades al objeto retornado al inciar sesión en AuthorizerFactory.cs
• Agregar variables al contexto de la sesión en AuthorizerFactory.cs
• Cambiar endpoint por defecto del swaggerUI en SwaggerFactory.cs

Crear un proyecto

1. Instalar la plantilla con el comando que se sugiere en la pagina de nuget.org.
2. Navegar hacia el directorio en donde ocupamos que se cree nuestro proyecto, por lineamiento la carpeta Git. Esto mediante un terminal.
3. Ejecutar el comando dotnet new clavis.web.app -o "nombre_de_su_proyecto".
4. Abrir la carpeta con el vs studio code y comprobar que el proyecto se creó correctamente. A este punto se encuentra preconfigurados
   los ambientes de clv_development, clv_staging y clv_master por defecto.
5. Recuerde reemplazar los ambientes preconfigurados por los de su requerimiento.

Crear una migración

En un terminal vamos a navegar hacia el directorio raíz del proyecto y vamos a ejecutar los siguientes comandos

1. dotnet ef migrations add InitialMigration -p Models -s Api -o Migrations. Reemplazar InitialMigration por el nombre de la migración.

Consideraciones para nombres de migraciones

1. Debe usar nomenclatura PascalCasing

Aplicar migraciones a una base de datos

En un terminal vamos a navegar hacia el directorio raíz del proyecto y vamos a ejecutar los siguientes comandos

1. set ASPNETCORE_ENVIRONMENT=clv_development. Reemplazar clv_development por el ambiente que deben aplicar la migración.
2. dotnet ef database update -p Models -s Api

Consideraciones al aplicar migraciones

1. El nombre del ambiente debe ser el mismo que el que indica en su archivo appsettings.ambiente.json,
   por ejemplo si su archivo de configuración se llama appsettings.clv_staging.json la variable
   ASPNETCORE_ENVIRONMENT debe tener el valor clv_development. Puede comprobar el valor cargado en
   la variable de ambiente con el comando echo %ASPNETCORE_ENVIRONMENT%

Solicitar una mejora

Si encuentra alguna opción de mejora, correción de errores puede crear una solicitud al
proyecto de Solicitudes internas https://clavisco.atlassian.net/jira/core/projects/SDS/summary