dotnet api boilerplate

Dotnet-api-boilerplate

A .Net 5.0 WebAPI -Boilerplate / Vorlageprojekt. Repositorys, Prahlerei, Mapper, Serilog und mehr implementiert.

Ziel dieses Projekts ist es, Ihr .NET -Webapi ein Kickstart zu sein, wobei die häufigsten verwendeten Muster und Technologien für eine erholsame API in .NET implementiert werden und Ihre Arbeit erleichtert werden.

Wie man rennt

• Verwenden Sie diese Vorlage (GitHub) oder klonen/download an Ihren lokalen Arbeitsplatz.
• Laden Sie den neuesten .NET SDK und Visual Studio/Code herunter.

Eigenständig

1. Möglicherweise benötigen Sie eine laufende Instanz von MSSQL, wobei entsprechende Migrationen initialisiert wurden.
   • Sie können nur die DB auf Docker ausführen. Dafür müssen Sie Ihre Verbindungszeichenfolge in "Server = 127.0.0.1; Database = Master; User = SA; Passwort = YourPassword123" ändern und den folgenden Befehl ausführen: docker-compose up -d db-server . Da die Anwendung in der Lage ist, den Container des DB -Servers zu erreichen.
   • Wenn Sie möchten, können Sie die Datenbank für die Verwendung von UseInMemoryDatabase anstelle von MSSQL ändern.
2. Gehen Sie zum Ordner SRC/Boilerplate.api und führen Sie dotnet run aus oder setzen Sie das API -Projekt in Visual Studio als Startup und führen Sie als Konsole oder Docker (nicht IIS) aus.
3. Besuchen Sie http: // localhost: 5000/api-docs oder https: // localhost: 5001/api-docs, um auf die Prahlerei der Anwendung zuzugreifen.

Docker

1. Führen Sie docker-compose up -d oder stellen Sie das Docker-Compose-Projekt in Visual Studio als Startup und Ausführen ein. Dies sollte die Anwendung und die DB starten.

• 1. Für Docker-Compose sollten Sie diesen Befehl im Root-Ordner ausführen: dotnet dev-certs https -ep https/aspnetapp.pfx -p yourpassword Ersetzen Sie "IhrPassword" mit etwas anderem in diesem Befehl und der Docker-compose.override.yml-Datei. Dadurch wird das HTTPS -Zertifikat erstellt.

2. Besuchen Sie http: // localhost: 5000/api-docs oder https: // localhost: 5001/api-docs, um auf die Prahlerei der Anwendung zuzugreifen.

Auslauftests

Führen Sie im Root -Ordner dotnet test aus. In diesem Befehl wird versucht, alle mit der SLN -Datei verbundenen Testprojekte zu finden.

Dieses Projekt enthält:

• Swaggerui
• EntityFramework
• Automapper
• Generisches Repository (um ein CRUD -Repository einfach zu starten)
• Serilog mit Anforderungsprotokollierung und leicht konfigurierbaren Waschbecken
• .NET -Abhängigkeitsinjektion
• Ressourcenfilterung
• Antwortkomprimierung
• CI (Github -Aktionen)
• Unit -Tests
• Integrationstests
• Containerunterstützung mit Docker und Docker-Compose

Projektstruktur

1. Dienstleistungen
   • Dieser Ordner speichert Ihre APIs und jedes Projekt, das Daten an Ihre Benutzer sendet.
   1. Boilerplate.api
      • Dies ist das Haupt -API -Projekt. Hier sind alle Controller und Initialisierung für die API, die verwendet werden.
   2. Docker-Compose
      • Dieses Projekt besteht, damit Sie Docker-Compose mit Visual Studio ausführen können. Es enthält einen Verweis auf die Docker-Compose-Datei und erstellt alle Projekteabhängigkeiten und führen sie aus.
2. Anwendung
   • Dieser Ordner speichert alle Datentransformationen zwischen Ihrer API und Ihrer Domänenschicht. Es enthält auch Ihre Geschäftslogik.
3. Domain
   • Dieser Ordner enthält Ihre Geschäftsmodelle, Enums und gemeinsame Schnittstellen.
   1. Boilerplate.domain.core
      • Enthält die Basisentität für alle anderen Domänenentitäten sowie die Schnittstelle für die Repository -Implementierung.
   2. Kesselplatte.Domain
      • Enthält Geschäftsmodelle und Aufzüge.
4. Infra
   • Dieser Ordner enthält alle Datenzugriffsrepositories, Datenbankkontexte, alles, was nach externen Daten reicht.
   1. Kesselplatte.infrastruktur
      • Dieses Projekt enthält den DBContext, eine generische Implementierung des Repository -Musters und ein Helden -Repository (Domain Class).

Adoption zu Ihrem Projekt

1. Entfernen Sie alle Heldenbezogenen Dinge in Ihre Bedürfnisse.
2. Benennen Sie Lösung, Projekte, Namespaces und Regeln in Ihre Verwendung um.
3. Ändern Sie die Dockerfile und Docker-compose.yml in Ihre neuen CSProj/Ordnernamen.
4. Geben Sie diesem Repo einen Stern!

Migrationen

1. Führen Sie den folgenden Befehl im Root -Ordner aus, um Migrationen in diesem Projekt auszuführen:

   • dotnet ef migrations add InitialCreate --startup-project .srcBoilerplate.Api --project .srcBoilerplate.Infrastructure

2. In diesem Befehl wird der Eintragspunkt für die Migration festgelegt (die für die Auswahl der DBProvider {SQLServer, MySQL usw. usw. und die Verbindungszeichenfolge) und das Projekt selbst ist die Infrastruktur, in der sich der DBContext befindet.

Wenn es Ihnen gefällt, gib ihm einen Stern

Wenn diese Vorlage für Sie nützlich war oder wenn Sie etwas gelernt haben, geben Sie ihr bitte einen Stern!

Danke

Dieses Projekt hat einen großen Einfluss von https://github.com/lkurzyniec/netcore-boilerplate und https://github.com/eduardopires/equinoxproject. Wenn Sie Zeit haben, besuchen Sie bitte diese Repos und geben Sie ihnen auch einen Stern!

Um

Diese Kesselplatte/diese Vorlage wurde von Yan Pitangui unter MIT -Lizenz entwickelt.