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分布式缓存。