aspnet api

ASPNET-API

Une API Core ASP.NET minimale

Exigences

• .NET 8.0 SDK
• Une base de données MySQL

Caractéristiques

• Openapi
• Conteneur d'injection de dépendance (avec automatique)
• Contrôleurs, services et référentiels simples
• Configuration spécifique à l'environnement
• Fondeuse de configuration .env 12 facteurs (pour les données sensibles)
• Connexion de la base de données MySQL
• SQL QueryBuilder (SQLKATA)
• Gestion des transactions de base de données
• Validation d'entrée (CluentValidation)
• ValidationException middleware
• Localisation (nGetText)
• Journalisation spécifique au contexte (Serilog)
• Journalisation d'erreur basée sur des fichiers
• Intégration continue (CI) Workflow avec actions GitHub
• Migrations de base de données (DBUP)

Essai

• Tests Xunit
• Tests de point de terminaison HTTP (à l'aide d'une base de données de test)
• Affirmations courantes pour les messages journaux

Faire

• Affirmations courantes pour les tests de base de données
• Authentification (BasicAuth)
• Créer un script

Installation

Exécutez la commande suivante pour créer un nouveau projet:

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

Remplacez {my-app-name} par le nom souhaité pour votre projet.

Créez une nouvelle base de données MySQL / MARIADB.

 CREATE DATABASE ` my_api ` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; 

Modifiez le nom de la base de données en conséquence.

Créez un fichier .env dans le répertoire MyApi :

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

Modifiez la base de données et les informations d'identification en conséquence.

Importez manuellement le fichier schema.sql ou exécutez la commande suivante:

 npm run migration:migrate

Remarque: cette commande nécessite NPM.

Commandes

Pour créer et exécuter l'application en mode débogage, exécutez:

 dotnet run

ou

 dotnet watch run

Exécution d'une version de version:

 dotnet run --configuration Release

Construisez un projet et ses dépendances:

 dotnet build

Construire un projet et ses dépendances en utilisant la configuration de la version:

 dotnet build --configuration Release

Nettoyage des répertoires Bin et OBJ:

 dotnet clean

Nettoyer et construire:

 dotnet rebuild

Publier:

 dotnet publish

Styles de code

Installez le package dotnet-format :

 dotnet tool install --global dotnet-format 

Vérification des styles de code:

 dotnet format --verify-no-changes

Fixation des styles de code:

 dotnet format -v d

Traductions

Déclarez l'interface IStringLocalizer<T> où vous devez traduire les messages.

Exemple

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

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

    // ...
}

Utilisation de la traduction

La langue par défaut et la langue source est l'anglais.

Traduction d'un message simple:

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

// Output: Hallo, Welt!

Traduction d'un message avec des espaces réservés: s):

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

// Output: Der Benutzer sally hat sich eingeloggt

Création d'un nouveau fichier de traduction

• Ouvrez Poedit et créez un nouveau fichier de traduction PO dans le répertoire Resources du projet.
• Le nom de fichier doit être le même que le nom de la culture, par exemple de-DE.po .
• Ouvrez les Translations du menu> Settings
• Changez la langue po, par exemple German
• Ajouter _localizer.GetString en tant que mot-clé Sources.
• Ajoutez les chemins source avec vos fichiers CS Project.
• Enregistrez le fichier et cliquez sur Update from source à l'analyse pour les nouvelles traductions.
• Traduisez les messages et enregistrez le fichier pour générer le fichier MO, par exemple de-DE.mo .

Changer la langue

Vous pouvez modifier la langue pendant la demande en définissant CurrentCulture comme suit:

 using using System . Globalization ;
// ...

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

Le LocalizationMiddleware détecte le langage utilisateur à l'aide de la valeur d'en-tête Accept-Language de demande HTTP. Si cet en-tête contient un code valide, la CurrentCulture sera commutée automatiquement.

Essai

Créez une base de données de test locale pour Xunit.

 CREATE DATABASE ` my_api_test ` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; 

Créez un fichier .env dans le répertoire MyApi.Tests :

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

Modifiez la base de données et les informations d'identification en conséquence.

Pour démarrer la suite de tests, exécutez:

 dotnet test

Licence

La licence MIT (MIT). Veuillez consulter le fichier de licence pour plus d'informations.