PolicyBuilder.NET 1.0.6

PolicyBuilder.NET

Overview

PolicyBuilder.NET is a library designed to enhance the resilience of Refit clients by integrating Polly policies. This library allows you to configure Refit clients with retry, circuit breaker, and timeout policies, ensuring that your HTTP requests are more robust and fault-tolerant.

Features

• Retry Policy: Automatically retries failed requests a specified number of times with a delay between each attempt.
• Circuit Breaker Policy: Monitors the number of consecutive failures and opens the circuit if the threshold is reached, preventing further requests for a specified duration.
• Timeout Policy: Enforces a maximum duration for each request, ensuring that long-running requests are terminated.

Installation

To install PolicyBuilder.NET, add the PolicyBuilder.NET NuGet package to your project:

dotnet add package PolicyBuilder.NET 

Configuration

appsettings.json

Configure your resiliency policies and Refit client settings in your appsettings.json file:

  "HttpBin": {
    "BaseUrl": "https://httpbin.org",
    "ResiliencyPolicies": {
            "RetryPolicy": {
        "Count": 3,
        "Delay": 2,
        "Jitter": 1000
      },
      "CircuitBreakerPolicy": {
        "Count": 5,
        "Duration": 5
      },
      "TimeoutPolicy": {
        "Duration": 10
      }
    }
  },

Example Usage

1. Define Your Refit Interface

Create an interface for your Refit client: Renders as:

public interface IMyRefitClient { [Get("/endpoint")] Task<ApiResponse> GetEndpointAsync(); }

How to use it

First step is to register the register the policies defined in the appsettings.json to the policy registry

    // Configure Polly policies
    var configuredPolicyName = services.ConfigurePollyPolicies<IMyRefitClient>(configuration, sectionName);

Once the policies are registered with the policy registry in the above method, we get the name of the policy as return value from the method. Use this to the http client builder(IHttpClientBuilder)

    // Configure the Refit client with the base URL and Polly policies
    services.AddRefitClient<IMyRefitClient>() // or any other means to //add your http client
        .AddPolicyHandlerFromRegistry(configuredPolicyName);

• TClient: The type of the Refit client.
• services: The service collection.
• configuration: The configuration.
• sectionName: The configuration section name.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any changes.

Contact

If you have any questions, suggestions, or would like to contribute to this project, feel free to reach out!

• Email: zameer.kh@gmail.com
• GitHub: @zameerkh

You can also open an issue on GitHub Issues if you encounter any problems or have feature requests.