tarathec tutorial backend

Dotnet チュートリアル バックエンド API

ASP.NET

ASP.NET は、.NET を使用して最新の Web アプリとサービスを構築するために Microsoft によって作成されたオープン ソース Web フレームワークです。 ASP.NET はクロスプラットフォームであり、Windows、Linux、macOS、Docker 上で実行されます。

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

プロジェクトの初期化

ソリューションプロジェクトの作成

 dotnet new sln -n Tutorial-Api

ASP.NET Web APIプロジェクトを作成する

 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/チュートリアルを取得する

  応答

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

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 

構成

環境変数

環境名	価値
チュートリアルDatabase__ConnectionString	mongodb://xxxxxxxx
チュートリアルデータベース__データベース名	チュートリアルデータベース
チュートリアルデータベース__チュートリアルコレクション名	チュートリアル

ログ記録と 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

...