tarathec tutorial backend

Dotnet-Tutorial-Backend-API

ASP.NET

ASP.NET ist ein von Microsoft entwickeltes Open-Source-Webframework zum Erstellen moderner Webanwendungen und -dienste mit .NET. ASP.NET ist plattformübergreifend und läuft unter Windows, Linux, macOS und Docker.

mehr: https://dotnet.microsoft.com/en-us/learn/aspnet/what-is-aspnet

Init-Projekt

Lösungsprojekt erstellen

 dotnet new sln -n Tutorial-Api

Erstellen Sie ein ASP.NET-Web-API-Projekt

 dotnet new webapi -o Api

Erstellen Sie ein XUnit-Projekt

 dotnet new xunit -o Xunit.Tests

Projekte zur Lösung hinzufügen

 dotnet sln add .Tutorial.ApiTutorial.Api.csproj
dotnet sln add .XUnit.TestsXUnit.Tests.csproj

Referenzprojekt zum xunit-Projekt hinzufügen

 dotnet add . /XUnit.Tests/XUnit.Tests.csproj reference .Tutorial.ApiTutorial.Api.csproj 

Init-Datenbank (MongoDB)

Fügen Sie den abhängigen MongoDB-Treiber zum Projekt hinzu

 dotnet add package MongoDB.Driver --version 2.18.0

Mongoshell

db.tutorials.find().pretty() ">

Install mongo-shell
https://www.mongodb.com/docs/mongodb-shell/install/

> mongod --dbpath < data_directory_path >

> show dbs

> use tutorialdb

> db.createCollection( ' tutorials ' )

> db.tutorials.insertMany([{ " title " : " Design Patterns " , " description " : " " , " published " : false}])

> db.tutorials.find().pretty ()

Laufen

 dotnet run --project . /Tutorial.Api/

Swagger: https://localhost:7272/swagger

https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-run#examples

• GET /api/tutorials

  Antwort

  [
      {
          "id" : " 63730beabd3cb05f2331be45 " ,
          "title" : " hello " ,
          "description" : " world " ,
          "published" : null ,
          "createdAt" : " 0001-01-01T00:00:00Z " ,
          "updatedAt" : " 0001-01-01T00:00:00Z "
      },
      {
          "id" : " 63732124796b18bc753e9157 " ,
          "title" : " dotnet " ,
          "description" : " microsoft " ,
          "published" : null ,
          "createdAt" : " 0001-01-01T00:00:00Z " ,
          "updatedAt" : " 0001-01-01T00:00:00Z "
      }
  ]

• GET /api/tutorials/{id}

  Antwort

  {
      "id" : " 63730beabd3cb05f2331be45 " ,
      "title" : " hello " ,
      "description" : " world " ,
      "published" : null ,
      "createdAt" : " 0001-01-01T00:00:00Z " ,
      "updatedAt" : " 0001-01-01T00:00:00Z "
  }

• POST /api/tutorials

  Anforderungstext

  {
      "title" : " string " ,
      "description" : " string " ,
  }

  Antwortgremium

  {
      "code" : " 200 " ,
      "message" : " Inserted a single document Success "
  }

• LÖSCHEN /api/tutorials

  Antwortgremium

  {
      "code" : " 200 " ,
      "message" : " All deleted "
  }

• LÖSCHEN /api/tutorials/{id}

  Antwortgremium

  {
      "code" : " 200 " ,
      "message" : " Deleted id 63730beabd3cb05f2331be45 "
  }

• PUT /api/tutorials/{id}

  Anforderungstext

      {
      "id" : " 63730beabd3cb05f2331be45 " ,
      "title" : " hello " ,
      "description" : " world " ,
      "published" : true
      }

  Antwortgremium

  {
      "code" : " 200 " ,
      "message" : " Deleted id 63730beabd3cb05f2331be45 "
  }

Bauen

 dotnet build

Als unterschiedliche Ebenen wiederherstellen

 dotnet restore

Erstellen und veröffentlichen Sie ein Release

 dotnet publish -c Release -o out 

Unit-Tests

Abdeckung ausführen

 dotnet test --collect:"XPlat Code Coverage"

ReportGenerator-Nuget hinzufügen

 dotnet add package ReportGenerator --version 5.1.10

Setup-Tool ReportGenerator

 dotnet tool install -g dotnet-reportgenerator-globaltool

mehr: https://www.nuget.org/packages/ReportGenerator

Führen Sie den HTML-Bericht aus

 reportgenerator -reports:"XUnit.TestsTestResults*coverage.cobertura.xml" -targetdir:". /coveragereport" -reporttypes:Html 

Konfigurationen

Umgebungsvariablen

Umgebungsname	Wert
TutorialDatabase__ConnectionString	mongodb://xxxxxxxx
TutorialDatabase__DatabaseName	Tutorialdb
TutorialDatabase__TutorialCollectionName	Tutorials

Die Protokollierung lässt sich in Azure Application Insights integrieren

https://learn.microsoft.com/en-us/azure/azure-monitor/app/ilogger#aspnet-core-applications

Fügen Sie das Paket ApplicationInsights hinzu

 dotnet add package Microsoft.ApplicationInsights.AspNetCore --version 2.21.0

...