Added configuration to specify the Url for the API.

Author: csharpfritz

Fritz.InstantAPIs/ApiMethodsToGenerate.cs

@@ -11,7 +11,11 @@ public enum ApiMethodsToGenerate
 	All = 31
 }
 
-public record TableApiMapping(string TableName, ApiMethodsToGenerate MethodsToGenerate = ApiMethodsToGenerate.All);
+public record TableApiMapping(
+	string TableName, 
+	ApiMethodsToGenerate MethodsToGenerate = ApiMethodsToGenerate.All, 
+	string BaseUrl = ""
+);
 
 [AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]
 public class ApiMethodAttribute : Attribute

Fritz.InstantAPIs/InstantAPIsConfig.cs

@@ -16,6 +16,7 @@ public class InstantAPIsConfigBuilder<D> where D : DbContext
 	private D _TheContext;
 	private readonly HashSet<TableApiMapping> _IncludedTables = new();
 	private readonly List<string> _ExcludedTables = new();
+	private const string DEFAULT_URI = "/api/";
 
 	public InstantAPIsConfigBuilder(D theContext)
 	{
@@ -30,13 +31,30 @@ public InstantAPIsConfigBuilder(D theContext)
 	/// <param name="entitySelector">Select the EntityFramework DbSet to include - Required</param>
 	/// <param name="methodsToGenerate">A flags enumerable indicating the methods to generate.  By default ALL are generated</param>
 	/// <returns>Configuration builder with this configuration applied</returns>
-	public InstantAPIsConfigBuilder<D> IncludeTable<T>(Func<D, DbSet<T>> entitySelector, ApiMethodsToGenerate methodsToGenerate = ApiMethodsToGenerate.All) where T : class
+	public InstantAPIsConfigBuilder<D> IncludeTable<T>(Func<D, DbSet<T>> entitySelector, ApiMethodsToGenerate methodsToGenerate = ApiMethodsToGenerate.All, string baseUrl = "") where T : class
 	{
 
 		var theSetType = entitySelector(_TheContext).GetType().BaseType;
 		var property = _ContextType.GetProperties().First(p => p.PropertyType == theSetType);
 
-		var tableApiMapping = new TableApiMapping(property.Name, methodsToGenerate);
+		if (!string.IsNullOrEmpty(baseUrl))
+		{
+			try
+			{
+				var testUri = new Uri(baseUrl, UriKind.RelativeOrAbsolute);
+				baseUrl = testUri.IsAbsoluteUri ? testUri.LocalPath : baseUrl;
+			}
+			catch
+			{
+				throw new ArgumentException(nameof(baseUrl), "Not a valid Uri");
+			}
+		}
+		else
+		{
+			baseUrl = String.Concat(DEFAULT_URI, property.Name);
+		}
+
+		var tableApiMapping = new TableApiMapping(property.Name, methodsToGenerate, baseUrl);
 		_IncludedTables.Add(tableApiMapping);
 
 		if (_ExcludedTables.Contains(tableApiMapping.TableName)) _ExcludedTables.Remove(tableApiMapping.TableName);
@@ -68,35 +86,33 @@ private void BuildTables()
 	{
 
 		var tables = WebApplicationExtensions.GetDbTablesForContext<D>().ToArray();
-
-		if (!_IncludedTables.Any() && !_ExcludedTables.Any())
-		{
-			_Config.Tables.UnionWith(tables.Select(t => new WebApplicationExtensions.TypeTable
-			{
-				Name = t.Name,
-				InstanceType = t.InstanceType,
-				ApiMethodsToGenerate = ApiMethodsToGenerate.All
-			}));
-			return;
-		}
+		WebApplicationExtensions.TypeTable[]? outTables;
 
 		// Add the Included tables
-		var outTables = tables.Where(t => _IncludedTables.Any(i => i.TableName.Equals(t.Name, StringComparison.InvariantCultureIgnoreCase)))
-			.Select(t => new WebApplicationExtensions.TypeTable
+		if (_IncludedTables.Any())
+		{
+			outTables = tables.Where(t => _IncludedTables.Any(i => i.TableName.Equals(t.Name, StringComparison.InvariantCultureIgnoreCase)))
+				.Select(t => new WebApplicationExtensions.TypeTable
+				{
+					Name = t.Name,
+					InstanceType = t.InstanceType,
+					ApiMethodsToGenerate = _IncludedTables.First(i => i.TableName.Equals(t.Name, StringComparison.InvariantCultureIgnoreCase)).MethodsToGenerate,
+					BaseUrl = new Uri(_IncludedTables.First(i => i.TableName.Equals(t.Name, StringComparison.InvariantCultureIgnoreCase)).BaseUrl, UriKind.Relative)
+				}).ToArray();
+		} else { 
+			outTables = tables.Select(t => new WebApplicationExtensions.TypeTable
 			{
 				Name = t.Name,
 				InstanceType = t.InstanceType,
-				ApiMethodsToGenerate = _IncludedTables.First(i => i.TableName.Equals(t.Name, StringComparison.InvariantCultureIgnoreCase)).MethodsToGenerate
+				BaseUrl = new Uri(DEFAULT_URI + t.Name, uriKind: UriKind.Relative)
 			}).ToArray();
+		}
 
-		// If no tables were added, added them all
-		if (outTables.Length == 0)
+		// Exit now if no tables were excluded
+		if (!_ExcludedTables.Any())
 		{
-			outTables = tables.Select(t => new WebApplicationExtensions.TypeTable
-			{
-				Name = t.Name,
-				InstanceType = t.InstanceType
-			}).ToArray();
+			_Config.Tables.UnionWith(outTables);
+			return;
 		}
 
 		// Remove the Excluded tables

Fritz.InstantAPIs/WebApplicationExtensions.cs

@@ -50,7 +50,7 @@ private static void MapInstantAPIsUsingReflection<D>(IEndpointRouteBuilder app,
 		{
 
 			// The default URL for an InstantAPI is /api/TABLENAME
-			var url = $"/api/{table.Name}";
+			//var url = $"/api/{table.Name}";
 
 			initialize.MakeGenericMethod(typeof(D), table.InstanceType).Invoke(null, new[] { logger });
 
@@ -64,7 +64,7 @@ private static void MapInstantAPIsUsingReflection<D>(IEndpointRouteBuilder app,
 				if ((table.ApiMethodsToGenerate & methodType) != methodType) continue;
 
 				var genericMethod = method.MakeGenericMethod(typeof(D), table.InstanceType);
-				genericMethod.Invoke(null, new object[] { app, url });
+				genericMethod.Invoke(null, new object[] { app, table.BaseUrl.ToString() });
 			}
 
 		}
@@ -100,7 +100,11 @@ internal static IEnumerable<TypeTable> GetDbTablesForContext<D>() where D : DbCo
 	{
 		return typeof(D).GetProperties(BindingFlags.Instance | BindingFlags.Public)
 								.Where(x => x.PropertyType.FullName.StartsWith("Microsoft.EntityFrameworkCore.DbSet"))
-								.Select(x => new TypeTable { Name = x.Name, InstanceType = x.PropertyType.GenericTypeArguments.First() })
+								.Select(x => new TypeTable { 
+									Name = x.Name, 
+									InstanceType = x.PropertyType.GenericTypeArguments.First(),
+									BaseUrl = new Uri($"/api/{x.Name}", uriKind: UriKind.RelativeOrAbsolute)
+								})
 								.ToArray();
 	}
 
@@ -109,6 +113,7 @@ internal class TypeTable
 		public string Name { get; set; }
 		public Type InstanceType { get; set; }
 		public ApiMethodsToGenerate ApiMethodsToGenerate { get; set; } = ApiMethodsToGenerate.All;
+		public Uri BaseUrl { get; set; }
 	}
 
 }

Test/Configuration/WhenIncludeDoesNotSpecifyBaseUrl.cs

@@ -0,0 +1,41 @@
+using Microsoft.AspNetCore.Builder;
+using Microsoft.EntityFrameworkCore;
+using Xunit;
+
+namespace Test.Configuration;
+
+public class WhenIncludeDoesNotSpecifyBaseUrl : BaseFixture
+{
+
+	InstantAPIsConfigBuilder<MyContext> _Builder;
+
+	public WhenIncludeDoesNotSpecifyBaseUrl()
+	{
+
+		var _ContextOptions = new DbContextOptionsBuilder<MyContext>()
+		.UseInMemoryDatabase("TestDb")
+		.Options;
+		_Builder = new(new(_ContextOptions));
+
+	}
+
+	[Fact]
+	public void ShouldSpecifyDefaultUrl()
+	{
+
+		// arrange
+
+		// act
+		_Builder.IncludeTable(db => db.Contacts);
+		var config = _Builder.Build();
+
+		// assert
+		Assert.Single(config.Tables);
+		Assert.Equal(new Uri("/api/Contacts", uriKind: UriKind.Relative), config.Tables.First().BaseUrl);
+
+	}
+
+
+}
+
+

Test/Configuration/WhenIncludeSpecifiesBaseUrl.cs

@@ -0,0 +1,48 @@
+using Microsoft.AspNetCore.Builder;
+using Microsoft.EntityFrameworkCore;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Xunit;
+
+namespace Test.Configuration;
+
+
+public class WhenIncludeSpecifiesBaseUrl : BaseFixture
+{
+
+	InstantAPIsConfigBuilder<MyContext> _Builder;
+
+	public WhenIncludeSpecifiesBaseUrl()
+	{
+
+		var _ContextOptions = new DbContextOptionsBuilder<MyContext>()
+		.UseInMemoryDatabase("TestDb")
+		.Options;
+		_Builder = new(new(_ContextOptions));
+
+	}
+
+	[Fact]
+	public void ShouldSpecifyThatUrl()
+	{
+
+		// arrange
+
+		// act
+		var BaseUrl = new Uri("/testapi", UriKind.Relative);
+		_Builder.IncludeTable(db => db.Contacts, baseUrl: BaseUrl.ToString());
+		var config = _Builder.Build();
+
+		// assert
+		Assert.Single(config.Tables);
+		Assert.Equal(BaseUrl, config.Tables.First().BaseUrl);
+
+	}
+
+
+}
+
+

WorkingApi/Program.cs

@@ -15,7 +15,7 @@
 
 app.MapInstantAPIs<MyContext>(config =>
 {
-	config.IncludeTable(db => db.Contacts, ApiMethodsToGenerate.All);
+	config.IncludeTable(db => db.Contacts, ApiMethodsToGenerate.All, "addressBook");
 });
 
 app.Run();