Merge pull request #42 from Shahinmm69/refactor/HCG-41

refactoring on the readme file for better understanding

Author: naeemaei

README.md

@@ -72,7 +72,7 @@ string requestBody = @"{""name"":""amin"",""requestId"":""10001000"",""amount"":
 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().ToString()}");
+httpRequestMessage.Headers.Add("Authorization", $"Bearer {Guid.NewGuid()}");
 
 using var httpClient = new HttpClient();
 httpClient.BaseAddress = new Uri("http://localhost:1213/v1/");
@@ -94,16 +94,14 @@ httpClient.GenerateCurlInConsole(
 string requestBody = @"{""name"":""justin"",""requestId"":10001026,""amount"":26000}";
 string requestUri = "api/test";
 var httpRequestMessage = new HttpRequestMessage(HttpMethod.Post, requestUri);
-    httpRequestMessage.Content = new FormUrlEncodedContent(new[]
+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().ToString()}");
-
+httpRequestMessage.Headers.Add("Authorization", $"Bearer {Guid.NewGuid()}");
 using var httpClient = new HttpClient();
 httpClient.BaseAddress = new Uri("http://localhost:1213/v1/");
-
 httpClient.GenerateCurlInConsole(
     httpRequestMessage,
     config =>
@@ -129,7 +127,7 @@ string requestBody = @"<?xml version = ""1.0"" encoding = ""UTF-8""?>
 
 var httpRequestMessage = new HttpRequestMessage(HttpMethod.Post, "api/test");
 httpRequestMessage.Content = new StringContent(requestBody, Encoding.UTF8, "application/json");
-httpRequestMessage.Headers.Add("Authorization", $"Bearer {Guid.NewGuid().ToString()}");
+httpRequestMessage.Headers.Add("Authorization", $"Bearer {Guid.NewGuid()}");
 
 using var httpClient = new HttpClient();
 httpClient.BaseAddress = new Uri("http://localhost:1213/v1/");
@@ -146,44 +144,37 @@ httpClient.GenerateCurlInConsole(
 // Call PostAsync => await client.PostAsync(requestUri, httpRequestMessage.Content);
 ```
 
-### **Post Method** sample code (it will be written in the **file**):
-
-If the path variable is null or empty, then the file is created in the **root project**.
-
-If the filename variable is null or empty, then the current date will be set for it with this format: **yyyyMMdd**
+### **Get Method** sample code (it will be written in the **console**):
 
 ```cs
-string path = string.Empty;
-string filename = "PostMethodResult" ;
-string requestBody = @"{""name"":""sara"",""requestId"":""10001001"",""amount"":20000}";
 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().ToString()}");
+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.GenerateCurlInFile(
+httpClient.GenerateCurlInConsole(
     httpRequestMessage,
     config =>
     {
-        config.Filename = filename;
-        config.Path = path;
         config.TurnOn = true;
         config.NeedAddDefaultHeaders = true;
+        config.EnableCodeBeautification = false;
     });
 
-// Call PostAsync => await client.PostAsync(requestUri, httpRequestMessage.Content);
+// Call GetAsync => await client.GetAsync(requestUri);
 ```
 
-### **Get Method** sample code (it will be written in the **console**):
+### **Put Method** sample code (it will be written in the **console**):
 
 ```cs
+string requestBody = @"{""name"":""jadi"",""requestId"":""10001003"",""amount"":30000}";
 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().ToString()}");
+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/");
@@ -197,47 +188,41 @@ httpClient.GenerateCurlInConsole(
         config.EnableCodeBeautification = false;
     });
 
-// Call GetAsync => await client.GetAsync(requestUri);
+// Call PutAsync => await client.PutAsync(requestUri, httpRequestMessage.Content);
 ```
 
-### **Get Method** sample code (it will be written in the **file**):
-
-If the path variable is null or empty, then the file is created in the **root project**.
-
-If the filename variable is null or empty, then the current date will be set for it with this format: **yyyyMMdd**
+### **Patch Method** sample code (it will be written in the **console**):
 
 ```cs
-string path = string.Empty;
-string filename = "GetMethodResult";
+string requestBody = @"{""name"":""hamed"",""requestId"":""10001005"",""amount"":50000}";
 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().ToString()}");
+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.GenerateCurlInFile(
+httpClient.GenerateCurlInConsole(
     httpRequestMessage,
     config =>
     {
-        config.Filename = filename;
-        config.Path = path;
         config.TurnOn = true;
         config.NeedAddDefaultHeaders = true;
+        config.EnableCodeBeautification = false;
     });
 
-// Call GetAsync => await client.GetAsync(requestUri);
+// Call PatchAsync => await client.PatchAsync(requestUri, httpRequestMessage.Content);
 ```
 
-### **Put Method** sample code (it will be written in the **console**):
+### **Delete Method** sample code (it will be written in the **console**):
 
 ```cs
-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().ToString()}");
+int id = 12;
+string requestUri = $"api/test/{id}";
+var httpRequestMessage = new HttpRequestMessage(HttpMethod.Delete, 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/");
@@ -251,23 +236,23 @@ httpClient.GenerateCurlInConsole(
         config.EnableCodeBeautification = false;
     });
 
-// Call PutAsync => await client.PutAsync(requestUri, httpRequestMessage.Content);
+// Call DeleteAsync => await client.DeleteAsync(requestUri);
 ```
 
-### **Put Method** sample code (it will be written in the **file**):
+### **Post Method** sample code (it will be written in the **file**):
 
-If the path variable is null or empty, then the file is created in the **root project**.
+If the path variable is null or empty, then the file is created in the **yourProjectPath/bin/Debug/netx.0**
 
 If the filename variable is null or empty, then the current date will be set for it with this format: **yyyyMMdd**
 
 ```cs
 string path = string.Empty;
-string filename = "PutMethodResult" ;
-string requestBody = @"{ ""name"" : ""reza"",""requestId"" : ""10001004"",""amount"":40000 }";
+string filename = "PostMethodResult" ;
+string requestBody = @"{""name"":""sara"",""requestId"":""10001001"",""amount"":20000}";
 string requestUri = "api/test";
-var httpRequestMessage = new HttpRequestMessage(HttpMethod.Put, requestUri);
+var httpRequestMessage = new HttpRequestMessage(HttpMethod.Post, requestUri);
 httpRequestMessage.Content = new StringContent(requestBody, Encoding.UTF8, "application/json");
-httpRequestMessage.Headers.Add("Authorization", $"Bearer {Guid.NewGuid().ToString()}");
+httpRequestMessage.Headers.Add("Authorization", $"Bearer {Guid.NewGuid()}");
 
 using var httpClient = new HttpClient();
 httpClient.BaseAddress = new Uri("http://localhost:1213/v1/");
@@ -282,47 +267,53 @@ httpClient.GenerateCurlInFile(
         config.NeedAddDefaultHeaders = true;
     });
 
-// Call PutAsync => await client.PutAsync(requestUri, httpRequestMessage.Content);
+// Call PostAsync => await client.PostAsync(requestUri, httpRequestMessage.Content);
 ```
 
-### **Patch Method** sample code (it will be written in the **console**):
+### **Get Method** sample code (it will be written in the **file**):
+
+If the path variable is null or empty, then the file is created in the **yourProjectPath/bin/Debug/netx.0**
+
+If the filename variable is null or empty, then the current date will be set for it with this format: **yyyyMMdd**
 
 ```cs
-string requestBody = @"{""name"":""hamed"",""requestId"":""10001005"",""amount"":50000}";
+string path = string.Empty;
+string filename = "GetMethodResult";
 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().ToString()}");
+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(
+httpClient.GenerateCurlInFile(
     httpRequestMessage,
     config =>
     {
+        config.Filename = filename;
+        config.Path = path;
         config.TurnOn = true;
         config.NeedAddDefaultHeaders = true;
-        config.EnableCodeBeautification = false;
     });
 
-// Call PatchAsync => await client.PatchAsync(requestUri, httpRequestMessage.Content);
+// Call GetAsync => await client.GetAsync(requestUri);
 ```
 
-### **Patch Method** sample code (it will be written in the **file**):
+### **Put Method** sample code (it will be written in the **file**):
 
-If the path variable is null or empty, then the file is created in the **root project**.
+If the path variable is null or empty, then the file is created in the **yourProjectPath/bin/Debug/netx.0**
 
 If the filename variable is null or empty, then the current date will be set for it with this format: **yyyyMMdd**
 
 ```cs
 string path = string.Empty;
-string filename = "PatchMethodResult" ;
-string requestBody = @"{ ""name"" : ""zara"",""requestId"" : ""10001006"",""amount"":60000 }";
+string filename = "PutMethodResult" ;
+string requestBody = @"{ ""name"" : ""reza"",""requestId"" : ""10001004"",""amount"":40000 }";
 string requestUri = "api/test";
-var httpRequestMessage = new HttpRequestMessage(HttpMethod.Patch, requestUri);
+var httpRequestMessage = new HttpRequestMessage(HttpMethod.Put, requestUri);
 httpRequestMessage.Content = new StringContent(requestBody, Encoding.UTF8, "application/json");
-httpRequestMessage.Headers.Add("Authorization", $"Bearer {Guid.NewGuid().ToString()}");
+httpRequestMessage.Headers.Add("Authorization", $"Bearer {Guid.NewGuid()}");
 
 using var httpClient = new HttpClient();
 httpClient.BaseAddress = new Uri("http://localhost:1213/v1/");
@@ -337,36 +328,43 @@ httpClient.GenerateCurlInFile(
         config.NeedAddDefaultHeaders = true;
     });
 
-// Call PatchAsync => await client.PatchAsync(requestUri, httpRequestMessage.Content);
+// Call PutAsync => await client.PutAsync(requestUri, httpRequestMessage.Content);
 ```
 
-### **Delete Method** sample code (it will be written in the **console**):
+### **Patch Method** sample code (it will be written in the **file**):
+
+If the path variable is null or empty, then the file is created in the **yourProjectPath/bin/Debug/netx.0**
+
+If the filename variable is null or empty, then the current date will be set for it with this format: **yyyyMMdd**
 
 ```cs
-int id = 12;
-string requestUri = $"api/test/{id}";
-var httpRequestMessage = new HttpRequestMessage(HttpMethod.Delete, requestUri);
-httpRequestMessage.Content = new StringContent(string.Empty, Encoding.UTF8, "application/json");
-httpRequestMessage.Headers.Add("Authorization", $"Bearer {Guid.NewGuid().ToString()}");
+string path = string.Empty;
+string filename = "PatchMethodResult" ;
+string requestBody = @"{ ""name"" : ""zara"",""requestId"" : ""10001006"",""amount"":60000 }";
+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(
+httpClient.GenerateCurlInFile(
     httpRequestMessage,
     config =>
     {
+        config.Filename = filename;
+        config.Path = path;
         config.TurnOn = true;
         config.NeedAddDefaultHeaders = true;
-        config.EnableCodeBeautification = false;
     });
 
-// Call DeleteAsync => await client.DeleteAsync(requestUri);
+// Call PatchAsync => await client.PatchAsync(requestUri, httpRequestMessage.Content);
 ```
 
 ### **Delete Method** sample code (it will be written in the **file**):
 
-If the path variable is null or empty, then the file is created in the **root project**.
+If the path variable is null or empty, then the file is created in the **yourProjectPath/bin/Debug/netx.0**
 
 If the filename variable is null or empty, then the current date will be set for it with this format: **yyyyMMdd**
 
@@ -377,7 +375,7 @@ int id = 12;
 string requestUri = $"api/test/{id}";
 var httpRequestMessage = new HttpRequestMessage(HttpMethod.Delete, requestUri);
 httpRequestMessage.Content = new StringContent(string.Empty, Encoding.UTF8, "application/json");
-httpRequestMessage.Headers.Add("Authorization", $"Bearer {Guid.NewGuid().ToString()}");
+httpRequestMessage.Headers.Add("Authorization", $"Bearer {Guid.NewGuid()}");
 
 using var httpClient = new HttpClient();
 httpClient.BaseAddress = new Uri("http://localhost:1213/v1/");