API template updates (#49394)

* Default webapi template to use minimal APIs & introduce option to use controllers
* Rename api template to webapiaot and remove aot option as it's always aot now

Author: DamianEdwards

src/ProjectTemplates/Shared/ArgConstants.cs

@@ -6,7 +6,7 @@ namespace Templates.Test.Helpers;
 internal static class ArgConstants
 {
     public const string UseProgramMain = "--use-program-main";
-    public const string UseMinimalApis = "--use-minimal-apis";
+    public const string UseControllers = "--use-controllers";
     public const string Pwa = "--pwa";
     public const string CallsGraph = "--calls-graph";
     public const string CalledApiUrl = "--called-api-url";

src/ProjectTemplates/Web.ProjectTemplates/Api-CSharp.csproj.in

@@ -6,10 +6,8 @@
     <ImplicitUsings>enable</ImplicitUsings>
     <NoDefaultLaunchSettingsFile Condition="'$(ExcludeLaunchSettings)' == 'True'">true</NoDefaultLaunchSettingsFile>
     <RootNamespace Condition="'$(name)' != '$(name{-VALUE-FORMS-}safe_namespace)'">Company.WebApplication1</RootNamespace>
-    <!--#if (NativeAot) -->
     <InvariantGlobalization>true</InvariantGlobalization>
     <PublishAot>true</PublishAot>
-    <!--#endif -->
   </PropertyGroup>
 
 </Project>

src/ProjectTemplates/Web.ProjectTemplates/content/Api-CSharp/.template.config/dotnetcli.host.json

@@ -21,10 +21,6 @@
     "UseProgramMain": {
       "longName": "use-program-main",
       "shortName": ""
-    },
-    "NativeAot": {
-      "longName": "aot",
-      "shortName": ""
     }
   },
   "usageExamples": [

src/ProjectTemplates/Web.ProjectTemplates/content/Api-CSharp/.template.config/ide.host.json

@@ -9,10 +9,6 @@
       "isVisible": true,
       "persistenceScope": "shared",
       "persistenceScopeName": "Microsoft"
-    },
-    {
-      "id": "NativeAot",
-      "isVisible": true
     }
   ]
 }

src/ProjectTemplates/Web.ProjectTemplates/content/Api-CSharp/.template.config/template.json

@@ -3,15 +3,17 @@
   "author": "Microsoft",
   "classifications": [
     "Web",
-    "API"
+    "Web API",
+    "API",
+    "Service"
   ],
-  "name": "ASP.NET Core API",
+  "name": "ASP.NET Core Web API (native AOT)",
   "generatorVersions": "[1.0.0.0-*)",
-  "description": "A project template for creating an ASP.NET Core API application.",
+  "description": "A project template for creating a RESTful Web API using ASP.NET Core minimal APIs published as native AOT.",
   "groupIdentity": "Microsoft.Web.Api",
   "precedence": "9000",
   "identity": "Microsoft.Web.Api.CSharp.8.0",
-  "shortName": "api",
+  "shortName": "webapiaot",
   "tags": {
     "language": "C#",
     "type": "project"
@@ -128,13 +130,6 @@
       "defaultValue": "false",
       "displayName": "Do not use _top-level statements",
       "description": "Whether to generate an explicit Program class and Main method instead of top-level statements."
-    },
-    "NativeAot" : {
-      "type": "parameter",
-      "datatype": "bool",
-      "defaultValue": "false",
-      "displayName": "Enable _native AOT publish",
-      "description": "Whether to enable the project for publishing as native AOT."
     }
   },
   "primaryOutputs": [

src/ProjectTemplates/Web.ProjectTemplates/content/Api-CSharp/Program.Main.cs

@@ -1,7 +1,5 @@
-#if NativeAot
 using System.Text.Json.Serialization;
 
-#endif
 namespace Company.ApiApplication1;
 
 public class Program
@@ -10,13 +8,11 @@ public static void Main(string[] args)
     {
         var builder = WebApplication.CreateSlimBuilder(args);
 
-        #if (NativeAot)
         builder.Services.ConfigureHttpJsonOptions(options =>
         {
             options.SerializerOptions.TypeInfoResolverChain.Insert(0, AppJsonSerializerContext.Default);
         });
 
-        #endif
         var app = builder.Build();
 
         var sampleTodos = new Todo[] {
@@ -40,7 +36,6 @@ public static void Main(string[] args)
 
 public record Todo(int Id, string? Title, DateOnly? DueBy = null, bool IsComplete = false);
 
-#if (NativeAot)
 [JsonSerializable(typeof(Todo[]))]
 internal partial class AppJsonSerializerContext : JsonSerializerContext
 {

src/ProjectTemplates/Web.ProjectTemplates/content/Api-CSharp/Program.cs

@@ -1,16 +1,12 @@
-#if (NativeAot)
 using System.Text.Json.Serialization;
 
-#endif
 var builder = WebApplication.CreateSlimBuilder(args);
 
-#if (NativeAot)
 builder.Services.ConfigureHttpJsonOptions(options =>
 {
     options.SerializerOptions.TypeInfoResolverChain.Insert(0, AppJsonSerializerContext.Default);
 });
 
-#endif
 var app = builder.Build();
 
 var sampleTodos = new Todo[] {
@@ -32,7 +28,6 @@
 
 public record Todo(int Id, string? Title, DateOnly? DueBy = null, bool IsComplete = false);
 
-#if (NativeAot)
 [JsonSerializable(typeof(Todo[]))]
 internal partial class AppJsonSerializerContext : JsonSerializerContext
 {

src/ProjectTemplates/Web.ProjectTemplates/content/GrpcService-CSharp/.template.config/template.json

@@ -3,11 +3,13 @@
   "author": "Microsoft",
   "classifications": [
     "Web",
-    "gRPC"
+    "gRPC",
+    "API",
+    "Service"
   ],
   "name": "ASP.NET Core gRPC Service",
   "generatorVersions": "[1.0.0.0-*)",
-  "description": "A project template for creating a gRPC ASP.NET Core service.",
+  "description": "A project template for creating a gRPC service using ASP.NET Core, with optional support for publishing as native AOT.",
   "groupIdentity": "Microsoft.Web.Grpc",
   "precedence": "9800",
   "identity": "Microsoft.Grpc.Service.CSharp.8.0",

src/ProjectTemplates/Web.ProjectTemplates/content/WebApi-CSharp/.template.config/dotnetcli.host.json

@@ -6,7 +6,12 @@
     },
     "UseMinimalAPIs": {
       "longName": "use-minimal-apis",
-      "shortName": "minimal"
+      "shortName": "minimal",
+      "isHidden": true
+    },
+    "UseControllers": {
+      "longName": "use-controllers",
+      "shortName": "controllers"
     },
     "AADInstance": {
       "longName": "aad-instance",

src/ProjectTemplates/Web.ProjectTemplates/content/WebApi-CSharp/.template.config/ide.host.json

@@ -26,10 +26,20 @@
         "overrideDefaultText": true
       },
       "invertBoolean": true,
-      "isVisible": true,
+      "isVisible": false,
       "defaultValue": "true",
       "persistenceScope": "templateGroup"
     },
+    {
+      "id": "UseControllers",
+      "name": {
+        "text": "Use controllers",
+        "overrideDefaultText": true
+      },
+      "isVisible": true,
+      "defaultValue": "false",
+      "persistenceScope": "templateGroup"
+    },
     {
       "id": "UseProgramMain",
       "isVisible": true,

src/ProjectTemplates/Web.ProjectTemplates/content/WebApi-CSharp/.template.config/template.json

@@ -3,11 +3,13 @@
   "author": "Microsoft",
   "classifications": [
     "Web",
-    "WebAPI"
+    "Web API",
+    "API",
+    "Service"
   ],
   "name": "ASP.NET Core Web API",
   "generatorVersions": "[1.0.0.0-*)",
-  "description": "A project template for creating an ASP.NET Core application with an example Controller for a RESTful HTTP service. This template can also be used for ASP.NET Core MVC Views and Controllers.",
+  "description": "A project template for creating a RESTful Web API using ASP.NET Core controllers or minimal APIs, with optional support for OpenAPI and authentication.",
   "groupIdentity": "Microsoft.Web.WebApi",
   "precedence": "9800",
   "identity": "Microsoft.Web.WebApi.CSharp.8.0",
@@ -55,19 +57,19 @@
           }
         },
         {
-          "condition": "(UseMinimalAPIs)",
+          "condition": "(UsingMinimalAPIs)",
           "exclude": [
             "Controllers/WeatherForecastController.cs"
           ]
         },
         {
-          "condition": "(UseMinimalAPIs && !UseProgramMain)",
+          "condition": "(UsingMinimalAPIs && !UseProgramMain)",
           "exclude": [
             "WeatherForecast.cs"
           ]
         },
         {
-          "condition": "(!UseProgramMain && UseMinimalAPIs && (NoAuth || WindowsAuth))",
+          "condition": "(!UseProgramMain && UsingMinimalAPIs && (NoAuth || WindowsAuth))",
           "exclude": [
             "Program.cs",
             "Program.MinimalAPIs.OrgOrIndividualB2CAuth.cs"
@@ -77,7 +79,7 @@
           }
         },
         {
-          "condition": "(!UseProgramMain && UseMinimalAPIs && (IndividualAuth || OrganizationalAuth))",
+          "condition": "(!UseProgramMain && UsingMinimalAPIs && (IndividualAuth || OrganizationalAuth))",
           "exclude": [
             "Program.cs",
             "Program.MinimalAPIs.WindowsOrNoAuth.cs"
@@ -87,7 +89,7 @@
           }
         },
         {
-          "condition": "(UseControllers)",
+          "condition": "(UsingControllers)",
           "exclude": [
             "Program.MinimalAPIs.WindowsOrNoAuth.cs",
             "Program.MinimalAPIs.OrgOrIndividualB2CAuth.cs"
@@ -321,9 +323,15 @@
     "UseMinimalAPIs": {
       "type": "parameter",
       "datatype": "bool",
-      "defaultValue": "false",
+      "defaultValue": "true",
       "description": "Whether to use minimal APIs instead of controllers."
     },
+    "UseControllers": {
+      "type": "parameter",
+      "datatype": "bool",
+      "defaultValue": "false",
+      "description": "Whether to use controllers instead of minimal APIs. This option overides the value specified by --minimal."
+    },
     "Framework": {
       "type": "parameter",
       "description": "The target framework for the project.",
@@ -388,13 +396,17 @@
       "defaultValue": "false",
       "description": "Disable OpenAPI (Swagger) support"
     },
-    "EnableOpenAPI": {
+    "UsingControllers": {
       "type": "computed",
-      "value": "(!DisableOpenAPI)"
+      "value": "(UseControllers || !UseMinimalAPIs)"
     },
-    "UseControllers": {
+    "UsingMinimalAPIs": {
+      "type": "computed",
+      "value": "(!UsingControllers)"
+    },
+    "EnableOpenAPI": {
       "type": "computed",
-      "value": "(!UseMinimalAPIs)"
+      "value": "(!DisableOpenAPI)"
     },
     "UseProgramMain": {
       "type": "parameter",

src/ProjectTemplates/Web.ProjectTemplates/content/WebApi-CSharp/Program.Main.cs

@@ -51,11 +51,11 @@ public static void Main(string[] args)
             .AddMicrosoftIdentityWebApi(builder.Configuration.GetSection("AzureAdB2C"));
         #endif
         #endif
-        #if (UseMinimalAPIs)
+        #if (UsingMinimalAPIs)
         builder.Services.AddAuthorization();
         #endif
 
-        #if (UseControllers)
+        #if (UsingControllers)
         builder.Services.AddControllers();
         #endif
         #if (EnableOpenAPI)
@@ -92,7 +92,7 @@ public static void Main(string[] args)
 
         app.UseAuthorization();
 
-        #if (UseMinimalAPIs)
+        #if (UsingMinimalAPIs)
         #if (OrganizationalAuth || IndividualB2CAuth)
         var scopeRequiredByApi = app.Configuration["AzureAd:Scopes"] ?? "";
         #endif
@@ -178,7 +178,7 @@ public static void Main(string[] args)
         });
         #endif
         #endif
-        #if (UseControllers)
+        #if (UsingControllers)
 
         app.MapControllers();
         #endif

src/ProjectTemplates/scripts/Run-ApiProgramMain-Locally.ps1

@@ -9,4 +9,4 @@ $ErrorActionPreference = 'Stop'
 
 . $PSScriptRoot\Test-Template.ps1
 
-Test-Template "api" "api" "Microsoft.DotNet.Web.ProjectTemplates.8.0.8.0.0-dev.nupkg" $false
+Test-Template "webapiaot" "webapiaot" "Microsoft.DotNet.Web.ProjectTemplates.8.0.8.0.0-dev.nupkg" $false

src/ProjectTemplates/scripts/Run-ApiProgramMainNativeAot-Locally.ps1

@@ -9,4 +9,4 @@ $ErrorActionPreference = 'Stop'
 
 . $PSScriptRoot\Test-Template.ps1
 
-Test-Template "api" "api -aot" "Microsoft.DotNet.Web.ProjectTemplates.8.0.8.0.0-dev.nupkg" $false
+Test-Template "webapiaot" "webapiaot --use-program-main" "Microsoft.DotNet.Web.ProjectTemplates.8.0.8.0.0-dev.nupkg" $false