dotnet webapi playground

C# dotnet Web API 遊樂場（許多範例 + Docker 部署）

情境

很多時候，我們需要發布 RESTful 微服務，並在 Docker 容器（Kubernetes、Google Cloud Run、Serverless 平台等）中進行詳細記錄和部署。

這個遊樂場專案展示了許多可以在專案中重複使用的功能。

這是一個即時項目，可能會經常更新。

這個應用程式有什麼作用？

• 該應用程式可以做很多事情。執行專案時會公開許多 Web api 端點。
• 查看文件（專案運行時的預設頁面）

專案中的堆疊和主要主題

• .NET 6.0 webapi 應用程式

  • C#
  • 休息WebAPI
  • 物件和 Json 解析器
  • 返回代碼（HTTP StatusCodes）操作
  • 記憶體快取
  • 哈希生成和哈希驗證
  • 本機 C# 資料類型擴充/覆蓋

• 碼頭工人

  • 碼頭工人建構
  • 碼頭運行
  • docker容器http/https交互

關於作者和許可

• Erick是一位資深後端開發人員和架構師。
• 您可以透過電子郵件 [email protected] 或 Linkedin https://www.linkedin.com/in/seixaserick/ 聯絡Erick
• 其他 Github 儲存庫：https://github.com/seixaserick/
• MIT 許可證（請查看 LICENSE.txt 以了解更多詳細資訊）

如何運行這個項目

克隆儲存庫

如果您已經安裝了 Windows 版 Git，請執行下列命令：

 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 的 Docker 容器中運行
• Json Parse 由 dotnet 以簡單且輕量的方式製作
• Docker 是一個很好的工具，可以快速運行項目，而無需擔心依賴關係和配置。
• C# 與其他基於 ECMA 的語言（Java、Javascript 等）非常相似
• 哈希演算法只是“一種方式”。您無法從給定的哈希中恢復輸入字串。
• 可以在 API 回應中輕鬆自訂回應代碼（例如：HTTP 409 衝突、HTTP 402 PaymentRequired 等）。查看完整的 HTTP 回應代碼。
• 好的 Markdown README.md 檔案可以幫助其他開發人員理解、複製、運行和測試專案。

家庭作業挑戰

1. 在 Models 資料夾中建立一個新的物件模型，並建立一個新的 api 端點（HTTP GET 方法）來執行一些計算並傳回這個新物件。
2. 建立一個新的 C# 資料類型擴充功能並使用它來操作您的本機資料類型。範例：建立一個string extension來執行.ToBase64Encode() ，然後您可以嘗試inputString.ToBase64Encode();相反函數方法。
3. 建立一個新的 POST API 端點來接收某個物件並對其執行某些操作，然後傳回結果。
4. 嘗試在某個端點實作Redis分散式快取。