NICWebApi.Extensions.AspNetCore 1.0.41

NICWebApi.Extensions.AspNetCore

ASP.NET Core 一键集成包，组合常用扩展的默认注册：

• DynamicAPI
• RESTfulResult
• JWT
• Mapper
• DependencyInjection
• Http
• RemoteRequest
• Caching
• Idempotency
• Schedule
• Messaging
• OperationLogging

安装

dotnet add package NICWebApi.Extensions.AspNetCore

使用

var builder = WebApplication.CreateBuilder(args);

builder.Services
    .AddControllers()
    .AddNICWebApiExtensions();

var app = builder.Build();

app.UseNICWebApiExtensions();
app.MapControllers();
app.Run();

可选配置

不传 IConfiguration 时，会优先使用 DI 中已有的配置；如果没有配置实例，则使用空配置和各模块默认值。 扩展自身能力默认开启，用户显式配置优先；Redis、生产密钥、第三方地址等外部资源仍需显式配置。 UseNICWebApiExtensions 只会挂载已经注册了对应服务的中间件，因此显式关闭模块后默认管道不会重新启用它。

{
  "NICWebApiExtensions": {
    "EnableDynamicApi": true,
    "EnableRESTfulResult": true,
    "EnableJwtAuthentication": true,
    "EnableCaching": true,
    "EnableIdempotency": true,
    "EnableMessaging": true,
    "EnableOperationLogging": true,
    "EnableSchedule": true,
    "Application": {
      "UseScheduleUI": true,
      "UseOperationLogging": true
    }
  },
  "RemoteRequest": {
    "BaseAddress": "https://api.example.com",
    "Timeout": "00:00:10"
  },
  "Caching": {
    "DefaultExpiration": "00:20:00",
    "Redis": {
      "Enabled": false,
      "Configuration": "localhost:6379",
      "InstanceName": "my-api:"
    }
  },
  "Idempotency": {
    "HeaderName": "Idempotency-Key",
    "Expiration": "00:10:00",
    "Redis": {
      "Enabled": false,
      "Configuration": "localhost:6379"
    }
  },
  "Messaging": {
    "Capacity": 1000,
    "ConsumerCount": 1,
    "MaxRetryCount": 3,
    "Redis": {
      "Enabled": false,
      "Configuration": "localhost:6379",
      "QueueKey": "my-api:messaging:queue"
    }
  },
  "OperationLogging": {
    "Provider": "Text",
    "TableName": "OperationLogs",
    "Text": {
      "Directory": "OperationLogs"
    },
    "Dashboard": {
      "Enabled": null,
      "Path": "/operation-logs",
      "PageSize": 50
    },
    "Capture": {
      "RequestQuery": true,
      "RequestBody": false,
      "ResponseBody": false,
      "MaxBodyLength": 8192
    },
    "CaptureRemoteRequests": true
  },
  "Schedule": {
    "Redis": {
      "Enabled": false,
      "Configuration": "localhost:6379",
      "KeyPrefix": "my-api:schedule:lock:"
    }
  }
}

builder.Services
    .AddControllers()
    .AddNICWebApiExtensions(options =>
    {
        options.Caching = cache => cache.UseRedis("localhost:6379", "my-api:");
        options.Idempotency = idempotency => idempotency.UseRedis("localhost:6379");
        options.Messaging = messaging => messaging.UseRedis("localhost:6379", "my-api:messaging:queue");
        options.Schedule = schedule => schedule.UseRedis("localhost:6379", "my-api:schedule:lock:");
        options.DynamicApi = api =>
        {
            api.Swagger.Title = "My API";
            api.Swagger.RoutePrefix = "swagger";
        };
    });

生产环境使用 JWT 时，请覆盖 JWT:IssuerSigningKey，不要使用默认开发密钥。