From 5f83b30cb28bc7179eb069633b2228524a4dc087 Mon Sep 17 00:00:00 2001 From: MattMo Date: Thu, 14 Dec 2023 11:33:42 -0800 Subject: [PATCH] Added ability to specify a RouteResponse and RouteRequest as a dynamic. Improved documentation and fixed some null checks that were missing with this change. Bumped package version to 1.7.6 --- Rest.Net.Example/Program.cs | 2 +- Rest.Net/Rest.Net.csproj | 2 +- Rest.Net/RestCSharpClientGenerator.cs | 26 +++++++++++++++++------ Rest.Net/RestClientGenerator.cs | 4 ++-- Rest.Net/RestJavascriptClientGenerator.cs | 6 +++--- Rest.Net/RouteRequest.cs | 5 +++++ Rest.Net/RouteResponse.cs | 7 +++++- 7 files changed, 37 insertions(+), 15 deletions(-) diff --git a/Rest.Net.Example/Program.cs b/Rest.Net.Example/Program.cs index a18e771..8237d14 100644 --- a/Rest.Net.Example/Program.cs +++ b/Rest.Net.Example/Program.cs @@ -211,7 +211,7 @@ namespace MontoyaTech.Rest.Net.Example } [RouteGroup("Auth")] - [RouteResponse(typeof(JObject))] + [RouteResponse(Dynamic = true)] public static HttpListenerResponse Dynamic(HttpListenerContext context) { return context.Response.WithStatus(HttpStatusCode.OK).WithJson(777); diff --git a/Rest.Net/Rest.Net.csproj b/Rest.Net/Rest.Net.csproj index a119ca5..0896012 100644 --- a/Rest.Net/Rest.Net.csproj +++ b/Rest.Net/Rest.Net.csproj @@ -17,7 +17,7 @@ MontoyaTech.Rest.Net MontoyaTech.Rest.Net True - 1.7.5 + 1.7.6 Logo_Symbol_Black_Outline.png diff --git a/Rest.Net/RestCSharpClientGenerator.cs b/Rest.Net/RestCSharpClientGenerator.cs index 45f6b2a..f754198 100644 --- a/Rest.Net/RestCSharpClientGenerator.cs +++ b/Rest.Net/RestCSharpClientGenerator.cs @@ -378,9 +378,9 @@ namespace MontoyaTech.Rest.Net //Generate the route function header if (this.StaticCode) - writer.Write($"public static {(routeResponse == null ? "void" : this.GetTypeFullyResolvedName(routeResponse.ResponseType))} {(routeName == null ? methodInfo.Name : routeName.Name)}("); + writer.Write($"public static {(routeResponse == null ? "void" : (routeResponse.Dynamic ? "dynamic" : this.GetTypeFullyResolvedName(routeResponse.ResponseType)))} {(routeName == null ? methodInfo.Name : routeName.Name)}("); else - writer.Write($"public {(routeResponse == null ? "void" : this.GetTypeFullyResolvedName(routeResponse.ResponseType))} {(routeName == null ? methodInfo.Name : routeName.Name)}("); + writer.Write($"public {(routeResponse == null ? "void" : (routeResponse.Dynamic ? "dynamic" : this.GetTypeFullyResolvedName(routeResponse.ResponseType)))} {(routeName == null ? methodInfo.Name : routeName.Name)}("); //Generate the functions parameters var parameters = methodInfo.GetParameters(); @@ -397,13 +397,25 @@ namespace MontoyaTech.Rest.Net if (routeRequest != null) { writer.WriteSeparator(); - writer.Write(this.GetTypeFullyResolvedName(routeRequest.RequestType)).Write(" request"); + + if (routeRequest.Dynamic) + writer.Write("dynamic"); + else + writer.Write(this.GetTypeFullyResolvedName(routeRequest.RequestType)); + + writer.Write(" request"); } if (routeResponse != null && routeResponse.Parameter) { writer.WriteSeparator(); - writer.Write(this.GetTypeFullyResolvedName(routeResponse.ResponseType)).Write(" input"); + + if (routeResponse.Dynamic) + writer.Write("dynamic"); + else + writer.Write(this.GetTypeFullyResolvedName(routeResponse.ResponseType)); + + writer.Write(" input"); } writer.WriteLine(")").WriteLine("{").Indent(); @@ -507,7 +519,7 @@ namespace MontoyaTech.Rest.Net { writer.WriteBreak().WriteLine("if (response.IsSuccessStatusCode)").WriteLine("{").Indent(); - if (routeResponse.ResponseType.IsAssignableTo(typeof(Stream))) + if (routeResponse.ResponseType != null && routeResponse.ResponseType.IsAssignableTo(typeof(Stream))) { if (routeResponse.Parameter) { @@ -532,7 +544,7 @@ namespace MontoyaTech.Rest.Net if (routeResponse.Json) { - writer.WriteBreak().WriteLine($"return JsonConvert.DeserializeObject<{this.GetTypeFullyResolvedName(routeResponse.ResponseType)}>(content);"); + writer.WriteBreak().WriteLine($"return JsonConvert.DeserializeObject<{(routeResponse.Dynamic ? "dynamic" : this.GetTypeFullyResolvedName(routeResponse.ResponseType))}>(content);"); } else { @@ -599,7 +611,7 @@ namespace MontoyaTech.Rest.Net break; case TypeCode.Object: - throw new NotSupportedException("ResponseType isn't JSON but is an object."); + throw new NotSupportedException("RouteResponse has JSON=false but ResponseType is an object."); } } } diff --git a/Rest.Net/RestClientGenerator.cs b/Rest.Net/RestClientGenerator.cs index 8e11355..edcc136 100644 --- a/Rest.Net/RestClientGenerator.cs +++ b/Rest.Net/RestClientGenerator.cs @@ -166,7 +166,7 @@ namespace MontoyaTech.Rest.Net var routeRequest = methodInfo.GetCustomAttribute(); - if (routeRequest != null) + if (routeRequest != null && routeRequest.RequestType != null) { var types = this.FindTypeDependencies(routeRequest.RequestType); @@ -177,7 +177,7 @@ namespace MontoyaTech.Rest.Net var routeResponse = methodInfo.GetCustomAttribute(); - if (routeResponse != null) + if (routeResponse != null && routeResponse.ResponseType != null) { var types = this.FindTypeDependencies(routeResponse.ResponseType); diff --git a/Rest.Net/RestJavascriptClientGenerator.cs b/Rest.Net/RestJavascriptClientGenerator.cs index a072e56..4d05da7 100644 --- a/Rest.Net/RestJavascriptClientGenerator.cs +++ b/Rest.Net/RestJavascriptClientGenerator.cs @@ -496,11 +496,11 @@ namespace MontoyaTech.Rest.Net //Generate request doc if any if (routeRequest != null) - writer.WriteLine($"@param {{{this.GetTypeFullyResolvedName(routeRequest.RequestType)}}} request"); + writer.WriteLine($"@param {{{(routeRequest.Dynamic ? "Any" : this.GetTypeFullyResolvedName(routeRequest.RequestType))}}} request"); //Generate response doc if any if (routeResponse != null) - writer.WriteLine($"@returns {{{this.GetTypeFullyResolvedName(routeResponse.ResponseType)}}}"); + writer.WriteLine($"@returns {{{(routeResponse.Dynamic ? "Any" : this.GetTypeFullyResolvedName(routeResponse.ResponseType))}}}"); writer.WriteLine("@throws {Response} If response status was not ok."); @@ -610,7 +610,7 @@ namespace MontoyaTech.Rest.Net { writer.WriteBreak().WriteLine("if (response.ok) {").Indent(); - if (routeResponse.ResponseType.IsAssignableTo(typeof(Stream))) + if (routeResponse.ResponseType != null && routeResponse.ResponseType.IsAssignableTo(typeof(Stream))) { if (routeResponse.Parameter) { diff --git a/Rest.Net/RouteRequest.cs b/Rest.Net/RouteRequest.cs index 65f6dc9..3d43907 100644 --- a/Rest.Net/RouteRequest.cs +++ b/Rest.Net/RouteRequest.cs @@ -22,6 +22,11 @@ namespace MontoyaTech.Rest.Net /// public bool Json = true; + /// + /// Whether or not the request is a dynamic type. Default is false. + /// + public bool Dynamic = false; + /// /// Creates a default route request. /// diff --git a/Rest.Net/RouteResponse.cs b/Rest.Net/RouteResponse.cs index a6b2214..583c397 100644 --- a/Rest.Net/RouteResponse.cs +++ b/Rest.Net/RouteResponse.cs @@ -23,10 +23,15 @@ namespace MontoyaTech.Rest.Net public bool Json = true; /// - /// Whether or not the response is passed as a parameter to the route function. + /// Whether or not the response is passed as a parameter to the route function. Default is false. /// public bool Parameter = false; + /// + /// Whether or not the response is a dynamic type. Default is false. + /// + public bool Dynamic = false; + /// /// Creates a default route response. ///