Dieses Dokument beschreibt die Implementierung einer robusten und standardisierten ASP.NET Core-API mithilfe von ProWebAPI. Es behandelt wichtige Aspekte wie Swagger-Integration, Abhängigkeitsinjektion, standardisierte Antworten, Versionierung, Anforderungsvalidierung, OData v4-Unterstützung, globale Ausnahmebehandlung und EF Core mit UnitOfWork. Die Anleitung enthält Schritt-für-Schritt-Anleitungen für jede Komponente.
ProWebAPI
ASP.NET Core API mit allen richtigen Standards
Umgesetzte Standards
Stolzieren
Installieren Sie Swagger
DI einrichten
Standardantwort für API
Standardantwort
Versionierung
Installieren Sie die Nuget-Bibliothek
Zum Abhängigkeitscontainer hinzufügen
Dekorieren Sie die Controller je nach Bedarf
Validator anfordern
Installieren Sie die Nuget-Bibliothek
Registrieren Sie Validatoren auf DI
Fügen Sie im Namespace „RequestDto“ die Validatoren zusammen mit dto hinzu
Erstellen Sie einen ValidationFilter
Registrieren Sie den Filter und deaktivieren Sie [ApiController] Auto 400 Bad Request Intercept
AppSettings.json
Konfigurieren Sie App-Einstellungen für Datenbanken
Erstellen Sie 2 ENVIRONMENT-Konfigurationen
OData v4
Um OData zu unterstützen, installieren Sie die NuGetpackages
Zum Service-DI für OData hinzufügen
OData konfigurieren
Überschreiben Sie das Attribut [EnableQuery] mit [EnableOData], um Fehler abzufangen und eine Standardantwort zurückzugeben
Dekorieren Sie die Aktionsmethode
Abfrage nach URL
Globaler Ausnahmehandler
Erstellen Sie die Middleware
Erstellen Sie eine Erweiterungsmethode für den App Builder
Registrieren Sie die Middleware
Antwortgehäuse
Erlauben Sie die Groß-/Kleinschreibung von Mitgliedern (bei Requisiten in Pascal-Schreibweise), damit das Ergebnis der OData-Abfrage nicht mit der Groß-/Kleinschreibung in Konflikt gerät
EF Core + UnitOfWork
Fügen Sie unterstützende Klassenbibliotheken hinzu
Installieren Sie die erforderlichen Pakete auf ProWeb.Data
Um Migrationen durchzuführen
Legen Sie ProWeb.Data als [Startprojekt] fest und führen Sie Migrationen aus