MgcFramework.ConnectApi 9.1.0

dotnet add package MgcFramework.ConnectApi --version 9.1.0
                    
NuGet\Install-Package MgcFramework.ConnectApi -Version 9.1.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MgcFramework.ConnectApi" Version="9.1.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="MgcFramework.ConnectApi" Version="9.1.0" />
                    
Directory.Packages.props
<PackageReference Include="MgcFramework.ConnectApi" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add MgcFramework.ConnectApi --version 9.1.0
                    
#r "nuget: MgcFramework.ConnectApi, 9.1.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package MgcFramework.ConnectApi@9.1.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=MgcFramework.ConnectApi&version=9.1.0
                    
Install as a Cake Addin
#tool nuget:?package=MgcFramework.ConnectApi&version=9.1.0
                    
Install as a Cake Tool

MgcFramework ConnectApi

MgcFramework ConnectApi is a .NET class library that provides tools to connect with any API. It includes services for making HTTP requests and handling responses.

Project Structure

Definitions/
	ConnectApiDefinition.cs
Dtos/
	HttpResponseWrapperDto.cs
Services/
	ApiClientService.cs

Getting Started

Prerequisites

  • .NET 9.0 SDK or later

Installation

To install the project dependencies, run the following command:

dotnet restore

Building the Project

To build the project, run the following command in the root directory:

dotnet build

Usage

ApiClientService

The ApiClientService class provides methods for making HTTP requests (GET, POST, PUT, PATCH, DELETE) to a specified API.

Example
using MgcFramework.ConnectApi.Services;
using System.Net.Http.Headers;

var apiClient = new ApiClientService("https://api.example.com", 120, new AuthenticationHeaderValue("Bearer", "your_token"));

var response = await apiClient.Get<MyResponseType>("endpoint");
if (!response.Error)
{
    var data = response.Response;
    // Handle the data
}
else
{
    Console.WriteLine(response.ErrorMessage);
}

HttpResponseWrapperDto

The HttpResponseWrapperDto<T> class wraps an HTTP response, providing additional metadata such as error status and messages.

Example
var responseWrapper = new HttpResponseWrapperDto<MyResponseType>(response, httpResponseMessage, false, "");
if (!responseWrapper.Error)
{
    var data = responseWrapper.Response;
    // Handle the data
}
else
{
    Console.WriteLine(responseWrapper.ErrorMessage);
}

Contributing

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

License

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

Author

Mtro. Christian Gómez Simón - [ChriisTKD]

Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net9.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
9.1.0 111 2/7/2025
9.0.0 116 1/24/2025