dotnet webapi playground

C# dotnet Web API プレイグラウンド (多くの例 + Docker デプロイ)

コンテクスト

多くの場合、十分に文書化され、Docker コンテナー (Kubernetes、Google Cloud Run、サーバーレス プラットフォームなど) にデプロイされた RESTful マイクロサービスを公開する必要があります。

このプレイグラウンド プロジェクトには、プロジェクトで再利用できる多くの機能が示されています。

これはライブプロジェクトであり、頻繁に更新される可能性があります。

このアプリケーションは何をするものですか?

• アプリは多くのことを行います。プロジェクトを実行すると、多くの Web API エンドポイントが公開されます。
• ドキュメントを参照してください (プロジェクト実行時のデフォルトページ)

プロジェクトのスタックと主要なトピック

• .NET 6.0 webapi アプリケーション

  • C#
  • REST WebAPI
  • オブジェクトとJsonパーサー
  • 戻りコード (HTTP StatusCode) の操作
  • メモリキャッシング
  • ハッシュ生成とハッシュ検証
  • ネイティブ C# データ型の拡張/オーバーライド

• ドッカー

  • ドッカービルド
  • ドッカーラン
  • Docker コンテナの http/https 相互作用

作者とライセンスについて

• Erickは上級バックエンド開発者兼アーキテクトです。
• Erickには、電子メール[email protected] または Linkedin https://www.linkedin.com/in/seixaserick/ で連絡できます。
• その他の Github リポジトリ: https://github.com/seixaserick/
• MIT ライセンス (詳細については、LICENSE.txt を確認してください)

このプロジェクトの実行方法

リポジトリのクローンを作成する

すでに Git for Windows をインストールしている場合は、以下のコマンドを実行します。

 git clone https://github.com/seixaserick/dotnet-webapi-playground
cd dotnet-webapi-playground

このプロジェクトを Docker コンテナーで実行する方法

すでに Docker Desktop をインストールしている場合は、以下の手順に従ってください。

Docker イメージの作成

Docker イメージを作成するには、プロジェクト ディレクトリのコマンド プロンプトで以下のコマンド ラインを実行します。

 docker build -t dotnet-webapi-playground -f Dockerfile .

Docker コンテナーでアプリを実行する

Redis インスタンスがない場合は、Docker で Redis サーバーをセットアップします

 docker run --name redis -d -p 6379:6379 -e REDIS_PASSWORD=supersecretpassword --restart always redis:latest /bin/sh -c 'redis-server --appendonly yes --requirepass ${REDIS_PASSWORD}'

Docker コンテナーでイメージを実行して操作するには、以下のコマンド ラインを実行します。

 docker run -it -p 1977:80 --name=dotnet-webapi-playground --restart=always dotnet-webapi-playground

開く: http://localhost:1977/square/8 (https なし)

コンテナを停止するには、以下のコマンドラインを実行します。

 docker stop dotnet-webapi-playground

コンテナーを削除するには (コンテナーが実行中の場合でも)、以下のコマンド ラインを実行します。

 docker rm --force dotnet-webapi-playground

Docker を使用せずにビルドして実行する方法 (Windows)

リポジトリのクローンを作成した後、Visual Studio でプロジェクトを開くことができます。ビルドするか、 F5押してデバッグします。

Windows でコンパイルして実行するには (Visual Studio が必要)

Visual Studio でソリューション ファイルdotnet-webapi-playground.slnを開き、 F5を押してプロジェクトを実行します。

テイクアウト

• Swagger は優れたドキュメント生成ツールです
• C# WebApi は、256MB 未満の RAM を搭載した Docker コンテナ内で実行するのに非常に軽量です。
• Json Parse は dotnet によって簡単かつ軽量な方法で作成されています
• Docker は、依存関係や構成を気にせずにプロジェクトを迅速に実行できる優れたツールです。
• C# は、他の ECMA ベースの言語 (Java、JavaScript など) と非常によく似ています。
• ハッシュ アルゴリズムは「一方向」のみです。指定されたハッシュから入力文字列を復元することはできません。
• API 応答で応答コードを簡単にカスタマイズできます (例: HTTP 409 Conflict、HTTP 402 PaymentRequired など)。完全な HTTP 応答コードを参照してください。
• 優れた Markdown README.md ファイルは、他の開発者がプロ​​ジェクトを理解、複製、実行、テストするのに役立ちます。

宿題チャレンジ

1. Models フォルダーに新しいオブジェクト モデルを作成し、計算を実行してこの新しいオブジェクトを返す新しい API エンドポイント (HTTP GET メソッド) を作成します。
2. 新しい C# データ型拡張機能を作成し、それを使用してネイティブ データ型を操作します。例: .ToBase64Encode()を実行するstring extensionを作成してから、 inputString.ToBase64Encode();代わりに関数アプローチ。
3. 新しい POST API エンドポイントを作成して、オブジェクトを受け取り、それに対して何かを実行して結果を返します。
4. いくつかのエンドポイントに Redis 分散キャッシュを実装してみます。