tarathec tutorial backend

Серверный API руководства по Dotnet

АСП.НЕТ

ASP.NET — это веб-платформа с открытым исходным кодом, созданная Microsoft для создания современных веб-приложений и сервисов с помощью .NET. ASP.NET является кроссплатформенным и работает в Windows, Linux, macOS и Docker.

подробнее: https://dotnet.microsoft.com/en-us/learn/aspnet/what-is-aspnet

Инициировать проект

Создать проект решения

 dotnet new sln -n Tutorial-Api

Создать проект веб-API ASP.NET.

 dotnet new webapi -o Api

Создать проект XUnit

 dotnet new xunit -o Xunit.Tests

Добавить проекты в решение

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

Добавить эталонный проект в проект xunit

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

База данных инициализации (MongoDB)

Добавить зависимость драйвера MongoDB в проект

 dotnet add package MongoDB.Driver --version 2.18.0

Монгольская ракушка

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 ()

Бегать

 dotnet run --project . /Tutorial.Api/

Сваггер: https://localhost:7272/swagger

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

• ПОЛУЧИТЬ /api/tutorials

  Ответ

  [
      {
          "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 "
      }
  ]

• ПОЛУЧИТЬ /api/tutorials/{id}

  Ответ

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

• POST/api/руководства

  Тело запроса

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

  Тело ответа

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

• УДАЛИТЬ /api/tutorials

  Тело ответа

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

• УДАЛИТЬ /api/tutorials/{id}

  Тело ответа

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

• PUT /api/tutorials/{id}

  Тело запроса

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

  Тело ответа

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

Строить

 dotnet build

Восстановить как отдельные слои

 dotnet restore

Сборка и публикация релиза

 dotnet publish -c Release -o out 

Модульные тесты

Покрытие пробега

 dotnet test --collect:"XPlat Code Coverage"

Добавить nuget ReportGenerator

 dotnet add package ReportGenerator --version 5.1.10

Инструмент настройки ReportGenerator

 dotnet tool install -g dotnet-reportgenerator-globaltool

подробнее: https://www.nuget.org/packages/ReportGenerator

Запустить HTML-отчет

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

Конфигурации

Переменные среды

Имя среды	Ценить
TutorialDatabase__ConnectionString	монгодб://хххххххх
TutorialDatabase__DatabaseName	учебникБДБ
TutorialDatabase__TutorialCollectionName	обучающие программы

Интеграция ведения журналов с Azure Application Insights.

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

Добавить пакет ApplicationInsights

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

...