aspnet api

ASPNET-API

Una API Core ASP.NET mínima

Requisitos

• .NET 8.0 SDK
• Una base de datos MySQL

Características

• Openapi
• Contenedor de inyección de dependencia (con AutoWiring)
• Controladores, servicios y repositorios de una sola acción
• Configuración específica del entorno
• Cargador de configuración .env de 12 factores (para datos confidenciales)
• Conexión de la base de datos MySQL
• SQL QueryBuilder (SQLKata)
• Manejo de la transacción de la base de datos
• Validación de entrada (Validación Fluent)
• Middleware de validationException
• Localización (Ngettext)
• Registro específico de contexto (Serilog)
• Registro de errores basado en archivos
• Flujo de trabajo de integración continua (CI) con acciones de GitHub
• Migraciones de bases de datos (DBUP)

Pruebas

• Pruebas de XUnit
• Pruebas de punto final HTTP (usando una base de datos de prueba)
• Afirmaciones fluidas para mensajes de registro

Hacer

• Afirmaciones fluidas para las pruebas de base de datos
• Autenticación (Basicauth)
• Construir guión

Instalación

Ejecute el siguiente comando para crear un nuevo proyecto:

 git clone https://github.com/odan/aspnet-api.git --depth 1 {my-app-name}
cd {my-app-name}

Reemplace {my-app-name} con el nombre deseado para su proyecto.

Cree una nueva base de datos MySQL / Mariadb.

 CREATE DATABASE ` my_api ` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; 

Modifique el nombre de la base de datos en consecuencia.

Cree un archivo .env en el directorio MyApi :

 MYSQL_HOST = localhost
MYSQL_PORT = 3306
MYSQL_USER = root
MYSQL_PASSWORD =
MYSQL_DATABASE = my_api

Modifique la base de datos y las credenciales en consecuencia.

Importe el archivo schema.sql manualmente o ejecute el siguiente comando:

 npm run migration:migrate

Nota: Este comando requiere NPM.

Comandos

Para construir y ejecutar la aplicación en modo de depuración, ejecute:

 dotnet run

o

 dotnet watch run

Ejecutando una versión de lanzamiento:

 dotnet run --configuration Release

Construir un proyecto y sus dependencias:

 dotnet build

Creación de un proyecto y sus dependencias utilizando la configuración de lanzamiento:

 dotnet build --configuration Release

Limpiar los directorios de Bin y OBJ:

 dotnet clean

Limpiar y construir:

 dotnet rebuild

Publicar:

 dotnet publish

Estilos de código

Instale el paquete dotnet-format :

 dotnet tool install --global dotnet-format 

Estilos de código de control:

 dotnet format --verify-no-changes

Estilos de código de fijación:

 dotnet format -v d

Traducciones

Declare la interfaz IStringLocalizer<T> donde necesita traducir mensajes.

Ejemplo

 public class Example
{
    private readonly IStringLocalizer < Example > _localizer ;

    public Example ( IStringLocalizer < Example > localizer )
    {
        _localizer = localizer ;
    }

    // ...
}

Uso de traducción

El idioma predeterminado y de origen es el inglés.

Traducir un mensaje simple:

 string text = _localizer . GetString ( "Hello, World!" ) ;

// Output: Hallo, Welt!

Traducir un mensaje con marcador de posición:

 string text2 = _localizer . GetString ( "The user {0} logged in" , "sally" ) ;

// Output: Der Benutzer sally hat sich eingeloggt

Creación de un nuevo archivo de traducción

• Abra Poedit y cree un nuevo archivo de traducción de PO en el directorio Resources del proyecto.
• El nombre de archivo debe ser el mismo que el nombre de la cultura, por ejemplo de-DE.po .
• Abra las Translations del menú> Settings
• Cambiar el idioma PO, por ejemplo German
• Agregue _localizer.GetString como palabra clave de fuentes.
• Agregue las rutas de origen con los archivos CS de su proyecto.
• Guarde el archivo y haga clic en Update from source para analizar nuevas traducciones.
• Traduce los mensajes y guarde el archivo para generar el archivo MO, por ejemplo, de-DE.mo .

Cambiar el idioma

Puede cambiar el idioma durante la solicitud estableciendo la cultura actual de la siguiente manera:

 using using System . Globalization ;
// ...

var culture = new CultureInfo ( "de-DE" ) ;
Thread . CurrentThread . CurrentCulture = culture ;
Thread . CurrentThread . CurrentUICulture = culture ;

La LocalizationMiddleware detecta el idioma de usuario utilizando el valor del encabezado del Accept-Language de la solicitud HTTP. Si este encabezado contiene un código válido, CurrentCulture se cambiará automáticamente.

Pruebas

Cree una base de datos de prueba local para XUnit.

 CREATE DATABASE ` my_api_test ` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; 

Cree un archivo .env en el directorio MyApi.Tests :

 MYSQL_HOST = localhost
MYSQL_PORT = 3306
MYSQL_USER = root
MYSQL_PASSWORD =
MYSQL_DATABASE = my_api_test

Modifique la base de datos y las credenciales en consecuencia.

Para comenzar la suite de prueba, ejecute:

 dotnet test

Licencia

La licencia MIT (MIT). Consulte el archivo de licencia para obtener más información.