FractalDataWorks.Web.Http.Abstractions 0.4.0-preview.6

FractalDataWorks.Web.Http.Abstractions

Core abstractions and TypeCollection definitions for HTTP-based web services in the FractalDataWorks platform. Provides endpoint types, security methods, and rate limiting policies using the TypeCollection pattern.

Installation

<PackageReference Include="FractalDataWorks.Web.Http.Abstractions" Version="1.0.0" />

Core Components

Endpoint Types

TypeCollection for categorizing HTTP endpoints. Each type defines default HTTP methods, caching behavior, and authentication requirements.

From EndpointTypes.cs:1-15:

[TypeCollection(typeof(EndpointTypeBase), typeof(IEndpointType), typeof(EndpointTypes))]
public partial class EndpointTypes : TypeCollectionBase<EndpointTypeBase, IEndpointType>
{
}

Available endpoint types:

From CRUD.cs:11-28:

[TypeOption(typeof(EndpointTypes), "CRUD")]
public sealed class CRUD : EndpointTypeBase
{
    public CRUD() : base(
        id: 1,
        name: "CRUD",
        description: "Create, Read, Update, Delete operations for data management",
        defaultHttpMethods: ["GET", "POST", "PUT", "DELETE", "PATCH"],
        requiresAuthentication: true,
        cachingStrategy: "NoCache",
        isReadOnly: false,
        supportsCaching: false,
        defaultCacheDurationSeconds: null,
        requiresValidation: true)
    {
    }
}

Security Methods

TypeCollection for authentication methods supported by the framework.

From SecurityMethods.cs:1-15:

[TypeCollection(typeof(SecurityMethodBase), typeof(ISecurityMethod), typeof(SecurityMethods))]
public partial class SecurityMethods : TypeCollectionBase<SecurityMethodBase, ISecurityMethod>
{
}

Available security methods:

From JWT.cs:11-17:

[TypeOption(typeof(SecurityMethods), "JWT")]
public sealed class JWT : SecurityMethodBase
{
    public JWT() : base(2, "JWT", requiresAuthentication: true, authenticationScheme: "Bearer", supportsTokenRefresh: true) { }
}

Rate Limiting Policies

TypeCollection for rate limiting strategies.

From RateLimitPolicies.cs:1-15:

[TypeCollection(typeof(RateLimitPolicyBase), typeof(IRateLimitPolicy), typeof(RateLimitPolicies))]
public partial class RateLimitPolicies : TypeCollectionBase<RateLimitPolicyBase, IRateLimitPolicy>
{
}

Available policies:

Usage

Access type options through the TypeCollection ByName lookup method.

From EndpointDefaultSettings.cs:10-27:

using FractalDataWorks.Web.Http.Abstractions.Policies;
using FractalDataWorks.Web.Http.Abstractions.Security;

public record EndpointDefaultSettings(
    string SecurityMethodName,
    string RateLimitPolicyName,
    int TimeoutMs,
    long MaxBodySize,
    bool RequireAuthentication,
    string[] AllowedRoles)
{
    public ISecurityMethod? SecurityMethod => SecurityMethods.ByName(SecurityMethodName);
    public IRateLimitPolicy? RateLimitPolicy => RateLimitPolicies.ByName(RateLimitPolicyName);
};

From SecurityConfiguration.cs:24-30:

public string DefaultSecurityMethod { get; init; } = string.Empty;

public ISecurityMethod? DefaultSecurityMethodEnum => SecurityMethods.ByName(DefaultSecurityMethod);

Related Packages

• FractalDataWorks.Web.RestEndpoints - Concrete endpoint implementations using these abstractions
• FractalDataWorks.Collections - TypeCollection base types and attributes