Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ethern-myth/efetch
efetch is a lightweight C# library for making HTTP requests with ease. It provides a simple interface for performing common HTTP operations such as GET, POST, PUT, PATCH, and DELETE. It also supports custom logging for requests, responses, and errors.
https://github.com/ethern-myth/efetch
csharp dotnet httpclient netcore restapi sdk singleton
Last synced: about 1 month ago
JSON representation
efetch is a lightweight C# library for making HTTP requests with ease. It provides a simple interface for performing common HTTP operations such as GET, POST, PUT, PATCH, and DELETE. It also supports custom logging for requests, responses, and errors.
- Host: GitHub
- URL: https://github.com/ethern-myth/efetch
- Owner: Ethern-Myth
- License: mit
- Created: 2024-03-13T12:13:43.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-03-14T12:38:08.000Z (10 months ago)
- Last Synced: 2024-12-02T09:05:43.783Z (about 1 month ago)
- Topics: csharp, dotnet, httpclient, netcore, restapi, sdk, singleton
- Language: C#
- Homepage:
- Size: 187 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# efetch
**efetch** is a lightweight C# library for making HTTP requests with ease. It provides a simple interface for performing common HTTP operations such as GET, POST, PUT, PATCH, and DELETE. It also supports custom logging for requests, responses, and errors.
### Installation
You can install **efetch** via NuGet Package Manager Console:
```bash
Install-Package efetch
```
Or via .NET CLI:
```bash
dotnet add package efetch
```
### Features
- Simple and intuitive API for making HTTP requests.
- Support for GET, POST, PUT, PATCH, and DELETE operations.
- Ability to customize default headers for requests.
- Support for query parameters.
- Lightweight and easy to integrate into existing projects.
### API
#### `IEFetchClient`
- `Task GetAsync(string endpointUrl, Dictionary? headers = null, Dictionary? queryParams = null, CancellationToken cancellationToken = default, dynamic? id = null)`: Performs a GET request.
- `Task PostAsync(string endpointUrl, TBody body, Dictionary? headers = null, Dictionary? queryParams = null, CancellationToken cancellationToken = default)`: Performs a POST request.
- `Task PutAsync(string endpointUrl, TBody body, Dictionary? headers = null, Dictionary? queryParams = null, CancellationToken cancellationToken = default, dynamic? id = null)`: Performs a PUT request.
- `Task PatchAsync(string endpointUrl, TBody body, Dictionary? headers = null, Dictionary? queryParams = null, CancellationToken cancellationToken = default, dynamic? id = null)`: Performs a PATCH request.
- `Task DeleteAsync(string endpointUrl, Dictionary? headers = null, Dictionary? queryParams = null, CancellationToken cancellationToken = default, dynamic? id = null)`: Performs a DELETE request.
#### `ILoggingProvider`
- `void LogRequest(HttpRequestMessage request)`: Logs the HTTP request.
- `void LogResponse(HttpResponseMessage response)`: Logs the HTTP response.
- `void LogError(Exception exception)`: Logs errors that occur during HTTP requests.
### Configuration
To use **efetch**, first configure the `EfetchConfig` class with the desired base URL and default headers.
```csharp
var config = new EfetchConfig
{
BaseUrl = "https://api.example.com",
DefaultHeaders = new Dictionary
{
{ "Authorization", "Bearer your_access_token" },
{ "Accept", "application/json" }
}
};
```
### Usage
You can integrate **efetch** with .NET Core in your `Program.cs` or just .cs file like the example below:
```csharp
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using efetch;
namespace YourNamespace
{
public class Program
{
public static void Main(string[] args)
{
var builder = WebApplication.CreateBuilder(args);
// Configure services
builder.Services.AddSingleton(new EfetchConfig
{
BaseUrl = "https://api.example.com",
DefaultHeaders = new Dictionary
{
{ "Authorization", "Bearer your_access_token" },
{ "Accept", "application/json" }
}
});
// Add other services...
var app = builder.Build();
// Pass the configured IServiceCollection to InstanceConfig method
var efetchInstance = Efetch.InstanceConfig(builder.Services);
// Run the application
app.Run();
}
}
}
```
On a .NET Core MVC
```csharp
builder.Services.AddTransient();
builder.Services.AddSingleton(new EfetchConfig { BaseUrl = "http://127.0.0.1" });
// This is important when using Program.cs
new EfetchConfig(builder.Services);
```
### Example
```csharp
var config = new EfetchConfig
{
BaseUrl = "https://api.example.com",
DefaultHeaders = new Dictionary
{
{ "Authorization", "Bearer your_access_token" },
{ "Accept", "application/json" }
},
RetryCount = 5,
RetryInterval = retryAttempt => TimeSpan.FromSeconds(Math.Pow(2, retryAttempt))
};
var efetch = Efetch.InstanceConfig(config);
// GET request example
var responseData = await efetch.GetAsync("/endpoint");
// POST request example
var requestBody = new RequestBody { /* request body properties */ };
var response = await efetch.PostAsync("/endpoint", requestBody);
```
In this example:
- We first create an instance of `Efetch` without any logging, default is set for us.
- We perform a GET request using the first client instance and display the result.
- We perform a POST request using the second client instance with console logging and display the result.
- Similarly, other HTTP operations like PUT, PATCH, and DELETE can be performed using their respective methods.
### Author
**efetch** is developed and maintained by [Ethern Myth](https://github.com/Ethern-Myth).
### License
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).