Merge pull request #382 from AcousticDeveloper/resolve-issue-132

Add CodeGen for C# HttpClient
This commit is contained in:
Ashita Prasad
2024-04-14 18:54:57 +05:30
committed by GitHub
5 changed files with 786 additions and 1 deletions

View File

@ -2,6 +2,7 @@ import 'package:apidash/models/models.dart' show RequestModel;
import 'package:apidash/consts.dart';
import 'package:apidash/utils/utils.dart' show getNewUuid;
import 'c/curl.dart';
import 'csharp/http_client.dart';
import 'csharp/rest_sharp.dart';
import 'dart/http.dart';
import 'dart/dio.dart';
@ -99,6 +100,8 @@ class Codegen {
return PHPcURLCodeGen().getCode(rM);
case CodegenLanguage.cCurlCodeGen:
return CCurlCodeGen().getCode(rM);
case CodegenLanguage.cSharpHttpClient:
return CSharpHttpClientCodeGen().getCode(rM);
case CodegenLanguage.cSharpRestSharp:
return CSharpRestSharp().getCode(rM);
case CodegenLanguage.phpHttpPlug:

View File

@ -0,0 +1,139 @@
import 'package:apidash/consts.dart';
import 'package:jinja/jinja.dart' as jj;
import 'package:apidash/models/models.dart' show RequestModel;
import 'package:apidash/utils/http_utils.dart';
class CSharpHttpClientCodeGen {
final String kTemplateNamespaces = r'''
using System;
using System.Net.Http;
{%- if formdata == 'multipart' %}
using System.IO;
{%- elif formdata == 'urlencoded' %}
using System.Collections.Generic;
{%- endif %}
''';
final String kTemplateUri = '''
string uri = "{{ uri }}";
''';
final String kTemplateHttpClientAndRequest = '''
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.{{ method | capitalize }}, uri))
{
''';
final String kTemplateHeaders = r'''
{% for name, value in headers -%}
request.Headers.Add("{{ name }}", "{{ value}}");
{% endfor %}
''';
final String kTemplateFormUrlEncodedContent = '''
var payload = new Dictionary<string, string>
{
{%- for data in formdata %}
{ "{{ data.name }}", "{{ data.value }}" },
{%- endfor %}
};
var content = new FormUrlEncodedContent(payload);
''';
final String kTemplateMultipartFormDataContent = r'''
var content = new MultipartFormDataContent
{
{%- for data in formdata %}
{%- if data.type == "text" %}
{ new StringContent("{{ data.value }}"), "{{ data.name }}" },
{%- else %}
{
new StreamContent(File.OpenRead("{{ data.value }}")),
"{{ data.name }}",
"{{ data.value }}"
},
{%- endif %}
{%- endfor %}
};
''';
final String kTemplateRawBody = '''
var payload = """
{{ body }}
""";
var content = new StringContent(payload, null, "{{ mediaType }}");
''';
final String kStringContentSetup = '''
request.Content = content;
''';
final kStringEnd = '''
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
String? getCode(RequestModel requestModel) {
try {
StringBuffer result = StringBuffer();
// Include necessary C# namespace
String formdataImport = requestModel.hasFormData
? "multipart" //(requestModel.hasFileInFormData ? "multipart" : "urlencoded")
: "nodata";
result.writeln(jj.Template(kTemplateNamespaces).render({"formdata": formdataImport}));
// Set request URL
var (uri, _) = getValidRequestUri(requestModel.url, requestModel.enabledRequestParams);
if (uri != null) {
result.writeln(jj.Template(kTemplateUri).render({"uri": uri}));
}
// Initialize HttpClient and create HttpRequestMessage
result.writeln(jj.Template(kTemplateHttpClientAndRequest).render({
"method": requestModel.method.name,
}));
// Set request headers
var headers = requestModel.enabledHeadersMap;
if (headers.isNotEmpty) {
result.writeln(jj.Template(kTemplateHeaders).render({"headers": headers}));
}
// Set request body if exists
if (kMethodsWithBody.contains(requestModel.method) && requestModel.hasBody) {
var requestBody = requestModel.requestBody;
if (!requestModel.hasFormData && requestBody != null && requestBody.isNotEmpty) {
// if the request body is not formdata then render raw text body
result.writeln(jj.Template(kTemplateRawBody).render({
"body": requestBody,
"mediaType": requestModel.requestBodyContentType.header,
}));
} else if (requestModel.hasFormData) {
// final String renderingTemplate = requestModel.hasFileInFormData
// ? kTemplateMultipartFormDataContent
// : kTemplateFormUrlEncodedContent;
final String renderingTemplate = kTemplateMultipartFormDataContent;
result.writeln(jj.Template(renderingTemplate).render({
"formdata": requestModel.formDataMapList,
}));
}
result.writeln(kStringContentSetup);
}
// Send request and get response
result.write(kStringEnd);
return result.toString();
} catch (e) {
return null;
}
}
}

View File

@ -273,6 +273,7 @@ enum CodegenLanguage {
curl("cURL", "bash", "curl"),
har("HAR", "json", "har"),
cCurlCodeGen("C (Curl)", "cpp", "c"),
cSharpHttpClient("C# (Http Client)", "cs", "cs"),
cSharpRestSharp("C# (Rest Sharp)", "cs", "cs"),
dartHttp("Dart (http)", "dart", "dart"),
dartDio("Dart (dio)", "dart", "dart"),

View File

@ -89,7 +89,7 @@ String stripUrlParams(String url) {
}
Map<String, String>? queryParams = rowsToMap(requestParams);
if (queryParams != null) {
if (queryParams != null && queryParams.isNotEmpty) {
if (uri.hasQuery) {
Map<String, String> urlQueryParams = uri.queryParameters;
queryParams = mergeMaps(urlQueryParams, queryParams);

View File

@ -0,0 +1,642 @@
import 'package:apidash/codegen/codegen.dart';
import 'package:apidash/consts.dart';
import 'package:test/test.dart';
import '../request_models.dart';
void main() {
final codeGen = Codegen();
group('Get Request', () {
test('GET 1', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://api.apidash.dev";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Get, uri))
{
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelGet1, "https"), expectedCode);
});
test('GET 2', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://api.apidash.dev/country/data?code=US";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Get, uri))
{
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelGet2, "https"), expectedCode);
});
test('GET 3', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://api.apidash.dev/country/data?code=IND";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Get, uri))
{
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelGet3, "https"), expectedCode);
});
test('GET 4', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://api.apidash.dev/humanize/social?num=8700000&digits=3&system=SS&add_space=true&trailing_zeros=true";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Get, uri))
{
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelGet4, "https"), expectedCode);
});
test('GET 5', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://api.github.com/repos/foss42/apidash";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Get, uri))
{
request.Headers.Add("User-Agent", "Test Agent");
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelGet5, "https"), expectedCode);
});
test('GET 6', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://api.github.com/repos/foss42/apidash?raw=true";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Get, uri))
{
request.Headers.Add("User-Agent", "Test Agent");
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelGet6, "https"), expectedCode);
});
test('GET 7', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://api.apidash.dev";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Get, uri))
{
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelGet7, "https"), expectedCode);
});
test('GET 8', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://api.github.com/repos/foss42/apidash?raw=true";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Get, uri))
{
request.Headers.Add("User-Agent", "Test Agent");
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelGet8, "https"), expectedCode);
});
test('GET 9', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://api.apidash.dev/humanize/social?num=8700000&add_space=true";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Get, uri))
{
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelGet9, "https"), expectedCode);
});
test('GET 10', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://api.apidash.dev/humanize/social";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Get, uri))
{
request.Headers.Add("User-Agent", "Test Agent");
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelGet10, "https"), expectedCode);
});
test('GET 11', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://api.apidash.dev/humanize/social?num=8700000&digits=3";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Get, uri))
{
request.Headers.Add("User-Agent", "Test Agent");
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelGet11, "https"), expectedCode);
});
test('GET 12', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://api.apidash.dev/humanize/social";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Get, uri))
{
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelGet12, "https"), expectedCode);
});
});
group('Head Request', () {
test('HEAD 1', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://api.apidash.dev";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Head, uri))
{
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelHead1, "https"), expectedCode);
});
test('HEAD 2', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "http://api.apidash.dev";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Head, uri))
{
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelHead2, "http"), expectedCode);
});
});
group('Post Request', () {
test('POST 1', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://api.apidash.dev/case/lower";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Post, uri))
{
var payload = """
{
"text": "I LOVE Flutter"
}
""";
var content = new StringContent(payload, null, "text/plain");
request.Content = content;
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelPost1, "https"), expectedCode);
});
test('POST 2', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://api.apidash.dev/case/lower";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Post, uri))
{
var payload = """
{
"text": "I LOVE Flutter",
"flag": null,
"male": true,
"female": false,
"no": 1.2,
"arr": ["null", "true", "false", null]
}
""";
var content = new StringContent(payload, null, "application/json");
request.Content = content;
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelPost2, "https"), expectedCode);
});
test('POST 3', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://api.apidash.dev/case/lower";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Post, uri))
{
request.Headers.Add("User-Agent", "Test Agent");
var payload = """
{
"text": "I LOVE Flutter"
}
""";
var content = new StringContent(payload, null, "application/json");
request.Content = content;
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelPost3, "https"), expectedCode);
});
test('POST 4', () {
const expectedCode = r'''using System;
using System.Net.Http;
using System.IO;
string uri = "https://api.apidash.dev/io/form";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Post, uri))
{
var content = new MultipartFormDataContent
{
{ new StringContent("API"), "text" },
{ new StringContent("|"), "sep" },
{ new StringContent("3"), "times" },
};
request.Content = content;
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelPost4, "https"), expectedCode);
});
test('POST 5', () {
const expectedCode = r'''using System;
using System.Net.Http;
using System.IO;
string uri = "https://api.apidash.dev/io/form";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Post, uri))
{
request.Headers.Add("User-Agent", "Test Agent");
var content = new MultipartFormDataContent
{
{ new StringContent("API"), "text" },
{ new StringContent("|"), "sep" },
{ new StringContent("3"), "times" },
};
request.Content = content;
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelPost5, "https"), expectedCode);
});
test('POST 6', () {
const expectedCode = r'''using System;
using System.Net.Http;
using System.IO;
string uri = "https://api.apidash.dev/io/img";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Post, uri))
{
var content = new MultipartFormDataContent
{
{ new StringContent("xyz"), "token" },
{
new StreamContent(File.OpenRead("/Documents/up/1.png")),
"imfile",
"/Documents/up/1.png"
},
};
request.Content = content;
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelPost6, "https"), expectedCode);
});
test('POST 7', () {
const expectedCode = r'''using System;
using System.Net.Http;
using System.IO;
string uri = "https://api.apidash.dev/io/img";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Post, uri))
{
var content = new MultipartFormDataContent
{
{ new StringContent("xyz"), "token" },
{
new StreamContent(File.OpenRead("/Documents/up/1.png")),
"imfile",
"/Documents/up/1.png"
},
};
request.Content = content;
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelPost7, "https"), expectedCode);
});
test('POST 8', () {
const expectedCode = r'''using System;
using System.Net.Http;
using System.IO;
string uri = "https://api.apidash.dev/io/form?size=2&len=3";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Post, uri))
{
var content = new MultipartFormDataContent
{
{ new StringContent("API"), "text" },
{ new StringContent("|"), "sep" },
{ new StringContent("3"), "times" },
};
request.Content = content;
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelPost8, "https"), expectedCode);
});
test('POST 9', () {
const expectedCode = r'''using System;
using System.Net.Http;
using System.IO;
string uri = "https://api.apidash.dev/io/img?size=2&len=3";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Post, uri))
{
request.Headers.Add("User-Agent", "Test Agent");
request.Headers.Add("Keep-Alive", "true");
var content = new MultipartFormDataContent
{
{ new StringContent("xyz"), "token" },
{
new StreamContent(File.OpenRead("/Documents/up/1.png")),
"imfile",
"/Documents/up/1.png"
},
};
request.Content = content;
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelPost9, "https"), expectedCode);
});
});
group('Put Request', () {
test('PUT 1', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://reqres.in/api/users/2";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Put, uri))
{
var payload = """
{
"name": "morpheus",
"job": "zion resident"
}
""";
var content = new StringContent(payload, null, "application/json");
request.Content = content;
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelPut1, "https"), expectedCode);
});
});
group('Patch Request', () {
test('PATCH 1', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://reqres.in/api/users/2";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Patch, uri))
{
var payload = """
{
"name": "marfeus",
"job": "accountant"
}
""";
var content = new StringContent(payload, null, "application/json");
request.Content = content;
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelPatch1, "https"), expectedCode);
});
});
group('Delete Request', () {
test('DELETE 1', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://reqres.in/api/users/2";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Delete, uri))
{
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelDelete1, "https"), expectedCode);
});
test('DELETE 2', () {
const expectedCode = r'''using System;
using System.Net.Http;
string uri = "https://reqres.in/api/users/2";
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Delete, uri))
{
var payload = """
{
"name": "marfeus",
"job": "accountant"
}
""";
var content = new StringContent(payload, null, "application/json");
request.Content = content;
HttpResponseMessage response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
''';
expect(codeGen.getCode(CodegenLanguage.cSharpHttpClient, requestModelDelete2, "https"), expectedCode);
});
});
}