IdempotentAPI 开源项目教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00586/article/details/141739829

IdempotentAPI 开源项目教程

IdempotentAPIA .NET library that handles the HTTP write operations (POST and PATCH) that can affect only once for the given request data and idempotency-key by using an ASP.NET Core attribute (filter).项目地址:https://gitcode.com/gh_mirrors/id/IdempotentAPI

1. 项目的目录结构及介绍

IdempotentAPI 项目的目录结构如下：

IdempotentAPI/
├── src/
│   ├── IdempotentAPI/
│   │   ├── Filters/
│   │   ├── Helpers/
│   │   ├── Middleware/
│   │   ├── Models/
│   │   ├── Services/
│   │   ├── IdempotentAPI.csproj
│   │   └── Startup.cs
│   └── IdempotentAPI.Tests/
│       ├── Properties/
│       ├── TestFiles/
│       ├── IdempotentAPI.Tests.csproj
│       └── UnitTest1.cs
├── .gitignore
├── IdempotentAPI.sln
└── README.md

目录结构介绍

src/IdempotentAPI/: 项目的主要源代码目录。
- Filters/: 包含用于处理请求过滤的类。
- Helpers/: 包含辅助工具类。
- Middleware/: 包含自定义中间件。
- Models/: 包含数据模型类。
- Services/: 包含服务类。
- IdempotentAPI.csproj: 项目文件。
- Startup.cs: 项目的启动文件。
src/IdempotentAPI.Tests/: 项目的测试代码目录。
- Properties/: 包含测试项目的属性文件。
- TestFiles/: 包含测试文件。
- IdempotentAPI.Tests.csproj: 测试项目文件。
- UnitTest1.cs: 单元测试文件。
.gitignore: Git 忽略文件。
IdempotentAPI.sln: 解决方案文件。
README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件是 Startup.cs，它位于 src/IdempotentAPI/ 目录下。该文件主要负责配置和启动应用程序。

Startup.cs 主要内容

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // 注册服务
        services.AddControllers();
        services.AddIdempotentAPI();
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        app.UseRouting();

        app.UseAuthorization();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllers();
        });
    }
}

启动文件功能介绍

ConfigureServices 方法: 用于注册应用程序所需的服务，如控制器、IdempotentAPI 服务等。
Configure 方法: 用于配置请求处理管道，包括路由、授权和端点配置。

3. 项目的配置文件介绍

项目的配置文件主要是 appsettings.json，它通常位于项目的根目录下。该文件用于配置应用程序的各种设置。

appsettings.json 示例

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*",
  "IdempotentAPI": {
    "CacheExpirationInMinutes": 10
  }
}