amingolmahalle / httpclienttocurlgenerator Goto Github PK

The HttpClientToCurl is a NuGet package for generating curl script of HttpClient in .NET ( C# | CSharp | Dotnet ) supported features: Post, Get, Put, and Delete. content types: application/json, text/xml, application/x-www-form-urlencoded

Home Page: https://www.nuget.org/packages/HttpClientToCurl

License: MIT License

C# 98.26% Shell 1.74%

asp-net-core aspnetcore csharp curl extension httpclient dotnet postman dotnet-standard json

httpclienttocurlgenerator's Introduction

🥇 HttpClientToCurl 🥇

An extension for generating the Curl script of HttpClient in .NET

This extension will help you to see whatever is set in HttpClient in the form of a curl script.

And you can check if that is the correct data for sending to an external service or not. also if you have an error, you can check the script find your problem, and fix that. so easily.

Also, it is the new way and fast way to create or update a collection of Postman, when you haven't got a postman collection for your desired external service.

It's easy to use. just you should install the package on your project from the below address and use sample codes for how to call and work with extensions.

For adding a package to your project from Nuget use this command

dotnet add package HttpClientToCurl

Nuget Package Address

You have 3 ways to see script result:

1- Put it in a string variable:

string curlScript = httpClientInstance.GenerateCurlInString(httpRequestMessage);

2- Show to the IDE console:

httpClientInstance.GenerateCurlInConsole(httpRequestMessage);

Notice: when the curl script was written in the console, maybe your IDE console applies WordWrap automatically. you should remove enters from the script.
Notice: You can set specific configurations for your result in the optional second parameter.

3- Write in a file:

httpClientInstance.GenerateCurlInFile(httpRequestMessage);

Notice: You can set specific configurations for your result in the optional second parameter.

Read more about this extension:

English Article

Persian Article

Please let me know if you have any feedback and your solution to improve the code and also if you find a problem. also, I will be extremely happy if you contribute to the implementation and improvement of the project.

Gmail Address

Give a Star! ⭐

If you like this project, learn something, or are using it in your applications, please give it a star. Thanks!

How to use HttpClientToCurl Extensions:

Post Method sample code (it will be written in the console):

string requestBody = @"{""name"":""amin"",""requestId"":""10001000"",""amount"":10000}";
string requestUri = "api/test";
var httpRequestMessage = new HttpRequestMessage(HttpMethod.Post, requestUri);
httpRequestMessage.Content = new StringContent(requestBody, Encoding.UTF8, "application/json");
httpRequestMessage.Headers.Add("Authorization", $"Bearer {Guid.NewGuid()}");

using var httpClient = new HttpClient();
httpClient.BaseAddress = new Uri("http://localhost:1213/v1/");

httpClient.GenerateCurlInConsole(
    httpRequestMessage,
    config =>
    {
        config.TurnOn = true;
        config.NeedAddDefaultHeaders = true;
        config.EnableCodeBeautification = false;
    });

 // Call PostAsync => await client.PostAsync(requestUri, httpRequestMessage.Content);

Post Method sample code for FormUrlEncodedContent (it will be written in the console):

string requestBody = @"{""name"":""justin"",""requestId"":10001026,""amount"":26000}";
string requestUri = "api/test";
var httpRequestMessage = new HttpRequestMessage(HttpMethod.Post, requestUri);
httpRequestMessage.Content = new FormUrlEncodedContent(new[]
{
    new KeyValuePair<string, string>("session", "703438f3-16ad-4ba5-b923-8f72cd0f2db9"),
    new KeyValuePair<string, string>("payload", requestBody),
});
httpRequestMessage.Headers.Add("Authorization", $"Bearer {Guid.NewGuid()}");
using var httpClient = new HttpClient();
httpClient.BaseAddress = new Uri("http://localhost:1213/v1/");
httpClient.GenerateCurlInConsole(
    httpRequestMessage,
    config =>
    {
        config.TurnOn = true;
        config.NeedAddDefaultHeaders = true;
        config.EnableCodeBeautification = false;
    });

// Call PostAsync => await client.PostAsync(requestUri, httpRequestMessage.Content);

Post Method sample code for XML (it will be written in the console):

string requestBody = @"<?xml version = ""1.0"" encoding = ""UTF-8""?>
    <Order>
    <Id>12</Id>
    <name>Jason</name>
    <requestId>10001024</requestId>
    <amount>240000</amount>
    </Order>";

var httpRequestMessage = new HttpRequestMessage(HttpMethod.Post, "api/test");
httpRequestMessage.Content = new StringContent(requestBody, Encoding.UTF8, "application/json");
httpRequestMessage.Headers.Add("Authorization", $"Bearer {Guid.NewGuid()}");

using var httpClient = new HttpClient();
httpClient.BaseAddress = new Uri("http://localhost:1213/v1/");

httpClient.GenerateCurlInConsole(
    httpRequestMessage,
    config: config =>
    {
        config.TurnOn = true;
        config.NeedAddDefaultHeaders = true;
        config.EnableCodeBeautification = false;
    });

// Call PostAsync => await client.PostAsync(requestUri, httpRequestMessage.Content);

Get Method sample code (it will be written in the console):

string requestUri = "api/test";
var httpRequestMessage = new HttpRequestMessage(HttpMethod.Get, requestUri);
httpRequestMessage.Content = new StringContent(string.Empty, Encoding.UTF8, "application/json");
httpRequestMessage.Headers.Add("Authorization", $"Bearer {Guid.NewGuid()}");

using var httpClient = new HttpClient();
httpClient.BaseAddress = new Uri("http://localhost:1213/v1/");

httpClient.GenerateCurlInConsole(
    httpRequestMessage,
    config =>
    {
        config.TurnOn = true;
        config.NeedAddDefaultHeaders = true;
        config.EnableCodeBeautification = false;
    });

// Call GetAsync => await client.GetAsync(requestUri);

Put Method sample code (it will be written in the console):

string requestBody = @"{""name"":""jadi"",""requestId"":""10001003"",""amount"":30000}";
string requestUri = "api/test";
var httpRequestMessage = new HttpRequestMessage(HttpMethod.Put, requestUri);
httpRequestMessage.Content = new StringContent(requestBody, Encoding.UTF8, "application/json");
httpRequestMessage.Headers.Add("Authorization", $"Bearer {Guid.NewGuid()}");

using var httpClient = new HttpClient();
httpClient.BaseAddress = new Uri("http://localhost:1213/v1/");

httpClient.GenerateCurlInConsole(
    httpRequestMessage,
    config =>
    {
        config.TurnOn = true;
        config.NeedAddDefaultHeaders = true;
        config.EnableCodeBeautification = false;
    });

// Call PutAsync => await client.PutAsync(requestUri, httpRequestMessage.Content);

Patch Method sample code (it will be written in the console):

string requestBody = @"{""name"":""hamed"",""requestId"":""10001005"",""amount"":50000}";
string requestUri = "api/test";
var httpRequestMessage = new HttpRequestMessage(HttpMethod.Patch, requestUri);
httpRequestMessage.Content = new StringContent(requestBody, Encoding.UTF8, "application/json");
httpRequestMessage.Headers.Add("Authorization", $"Bearer {Guid.NewGuid()}");

using var httpClient = new HttpClient();
httpClient.BaseAddress = new Uri("http://localhost:1213/v1/");

httpClient.GenerateCurlInConsole(
    httpRequestMessage,
    config =>
    {
        config.TurnOn = true;
        config.NeedAddDefaultHeaders = true;
        config.EnableCodeBeautification = false;
    });

// Call PatchAsync => await client.PatchAsync(requestUri, httpRequestMessage.Content);