ProWebAPI

Ce document détaille la mise en œuvre d'une API ASP.NET Core robuste et standardisée à l'aide de ProWebAPI. Il couvre des aspects clés tels que l'intégration de Swagger, l'injection de dépendances, les réponses standardisées, la gestion des versions, la validation des demandes, la prise en charge d'OData v4, la gestion globale des exceptions et EF Core avec UnitOfWork. Le guide fournit des instructions étape par étape pour chaque composant.

APIProWeb

API ASP.NET Core avec toutes les normes appropriées

Normes mises en œuvre

Fanfaronnade

Installer Swagger

Configuration DI

Réponse standard pour l'API

Réponse standard

Gestion des versions

Installer la bibliothèque Nuget

Ajouter au conteneur de dépendances

Décorez les contrôleurs en fonction des besoins

Validateur de demande

Installer la bibliothèque Nuget

Enregistrer les validateurs sur DI

Sur l'espace de noms 'RequestDto', ajoutez les validateurs avec dto

Créer un filtre de validation

Enregistrez le filtre et désactivez [ApiController] auto 400 Bad Request intercept

AppSettings.json

Configurer les paramètres d'application pour les bases de données

Créer 2 configurations ENVIRONNEMENT

ODatav4

Pour prendre en charge OData, installez les packages NuGet

Ajouter au service DI pour OData

Configurer OData

Remplacez l'attribut [EnableQuery] par [EnableOData] pour détecter les erreurs et renvoyer une réponse standard

Décorez la méthode d'action

Requête par URL

Gestionnaire d'exceptions globales

Créer le middleware

Créer une méthode d'extension pour le générateur d'applications

Enregistrez le middleware

Boîtier de réponse

Autoriser la casse des membres (qui sera en casse pascal pour les accessoires) afin que le résultat de la requête OData n'entre pas en conflit avec la casse

EF Core + UnitOfWork

Ajouter des bibliothèques de classes de prise en charge

Installez les packages requis sur ProWeb.Data

Pour exécuter des migrations

DÉFINIR ProWeb.Data comme [Projet de démarrage] et exécuter les migrations