WN:v10:Move OpenAPI inline code to sample

Author: wadepickett

aspnetcore/release-notes/aspnetcore-10/includes/openApi.md

@@ -15,7 +15,9 @@ Some of the changes you will see in the generated OpenAPI document include:
 and have a `pattern` field limiting the value to digits.
 This happens when the <xref:System.Text.Json.JsonSerializerOptions.NumberHandling> property in the <xref:System.Text.Json.JsonSerializerOptions> is set to `AllowReadingFromString`, the default for ASP.NET Core Web apps. To enable C# `int` and `long` to be represented in the OpenAPI document as `type: integer`, set the <xref:System.Text.Json.JsonSerializerOptions.NumberHandling> property to `Strict`.
 
-With this feature, the default OpenAPI version for generated documents is`3.1`. The version can be changed by explicitly setting the [OpenApiVersion](/dotnet/api/microsoft.aspnetcore.openapi.openapioptions.openapiversion) property of the [OpenApiOptions](/dotnet/api/microsoft.aspnetcore.openapi.openapioptions) in the `configureOptions` delegate parameter of [AddOpenApi](/dotnet/api/microsoft.extensions.dependencyinjection.openapiservicecollectionextensions.addopenapi).
+With this feature, the default OpenAPI version for generated documents is`3.1`. The version can be changed by explicitly setting the [OpenApiVersion](/dotnet/api/microsoft.aspnetcore.openapi.openapioptions.openapiversion) property of the [OpenApiOptions](/dotnet/api/microsoft.aspnetcore.openapi.openapioptions) in the `configureOptions` delegate parameter of [AddOpenApi](/dotnet/api/microsoft.extensions.dependencyinjection.openapiservicecollectionextensions.addopenapi):
+
+:::code language="csharp" source="~/release-notes/aspnetcore-10/samples/WebAppOpenAPI10/Program.cs" id="snippet_AddControllers" highlight="3":::
 
 ```csharp
 builder.Services.AddOpenApi(options =>
@@ -25,7 +27,9 @@ builder.Services.AddOpenApi(options =>
 });
 ```
 
-When generating the OpenAPI document at build time, the OpenAPI version can be selected by setting the `--openapi-version` in the `OpenApiGenerateDocumentsOptions` MSBuild item.
+When generating the OpenAPI document at build time, the OpenAPI version can be selected by setting the `--openapi-version` in the `OpenApiGenerateDocumentsOptions` MSBuild item:
+
+:::code language="csharp" source="~/release-notes/aspnetcore-10/samples/WebAppOpenAPI10/WebAppOpenAPI10.csproj" id="snippet_ConfigBuildTimeOpenApiDocVersion" highlight="7":::
 
 ```xml
     <!-- Configure build-time OpenAPI generation to produce an OpenAPI 3.0 document. -->
@@ -44,6 +48,8 @@ Breaking changes in this iteration include the following:
 
 One of the most significant changes is that the `OpenApiAny` class has been dropped in favor of using `JsonNode` directly. Transformers that use `OpenApiAny` need to be updated to use `JsonNode`. The following diff shows the changes in schema transformer from .NET 9 to .NET 10: 
 
+:::code language="csharp" source="~/release-notes/aspnetcore-10/samples/WebAppOpenAPI10/TransformerJsonNode.diff":::
+
 ```diff
 options.AddSchemaTransformer((schema, context, cancellationToken) =>
 {
@@ -74,6 +80,8 @@ ASP.NET now supports serving the generated OpenAPI document in YAML format. YAML
 
 To configure an app to serve the generated OpenAPI document in YAML format, specify the endpoint in the MapOpenApi call with a ".yaml" or ".yml" suffix, as shown in the following example:
 
+:::code language="csharp" source="~/release-notes/aspnetcore-10/samples/WebAppOpenAPI10/Program.cs" id="snippet_ConfigOpenApiYAM" highlight="3":::
+
 ```csharp
 app.MapOpenApi("/openapi/{documentName}.yaml");
 ```

aspnetcore/release-notes/aspnetcore-10/samples/WebAppOpenAPI10/Controllers/WeatherForecastController.cs

@@ -0,0 +1,26 @@
+using Microsoft.AspNetCore.Mvc;
+
+namespace WebAppOpenAPI10.Controllers
+{
+    [ApiController]
+    [Route("[controller]")]
+    public class WeatherForecastController : ControllerBase
+    {
+        private static readonly string[] Summaries =
+        [
+            "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
+        ];
+
+        [HttpGet(Name = "GetWeatherForecast")]
+        public IEnumerable<WeatherForecast> Get()
+        {
+            return Enumerable.Range(1, 5).Select(index => new WeatherForecast
+            {
+                Date = DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
+                TemperatureC = Random.Shared.Next(-20, 55),
+                Summary = Summaries[Random.Shared.Next(Summaries.Length)]
+            })
+            .ToArray();
+        }
+    }
+}

aspnetcore/release-notes/aspnetcore-10/samples/WebAppOpenAPI10/Program.cs

@@ -0,0 +1,29 @@
+var builder = WebApplication.CreateBuilder(args);
+
+// Add services to the container.
+builder.Services.AddControllers();
+// Learn more about configuring OpenAPI at https://aka.ms/aspnet/openapi
+// <snippet_DefaultOpenApiVersion>
+builder.Services.AddOpenApi(options =>
+{
+    options.OpenApiVersion = Microsoft.OpenApi.OpenApiSpecVersion.OpenApi3_0;
+});
+// </snippet_DefaultOpenApiVersion>
+
+var app = builder.Build();
+
+// Configure the HTTP request pipeline.
+// <snippet_ConfigOpenApiYAML>
+if (app.Environment.IsDevelopment())
+{
+    app.MapOpenApi("/openapi/{documentName}.yaml");
+}
+// </snippet_ConfigOpenApiYAML>
+
+app.UseHttpsRedirection();
+
+app.UseAuthorization();
+
+app.MapControllers();
+
+app.Run();

aspnetcore/release-notes/aspnetcore-10/samples/WebAppOpenAPI10/TransformerJsonNode.diff

@@ -0,0 +1,19 @@
+options.AddSchemaTransformer((schema, context, cancellationToken) =>
+{
+    if (context.JsonTypeInfo.Type == typeof(WeatherForecast))
+    {
+-       schema.Example = new OpenApiObject
++       schema.Example = new JsonObject
+        {
+-           ["date"] = new OpenApiString(DateTime.Now.AddDays(1).ToString("yyyy-MM-dd")),
++           ["date"] = DateTime.Now.AddDays(1).ToString("yyyy-MM-dd"),
+-           ["temperatureC"] = new OpenApiInteger(0),
++           ["temperatureC"] = 0,
+-           ["temperatureF"] = new OpenApiInteger(32),
++           ["temperatureF"] = 32,
+-           ["summary"] = new OpenApiString("Bracing"),
++           ["summary"] = "Bracing",
+        };
+    }
+    return Task.CompletedTask;
+});

aspnetcore/release-notes/aspnetcore-10/samples/WebAppOpenAPI10/WeatherForecast.cs

@@ -0,0 +1,13 @@
+namespace WebAppOpenAPI10
+{
+    public class WeatherForecast
+    {
+        public DateOnly Date { get; set; }
+
+        public int TemperatureC { get; set; }
+
+        public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
+
+        public string? Summary { get; set; }
+    }
+}

aspnetcore/release-notes/aspnetcore-10/samples/WebAppOpenAPI10/WebAppOpenAPI10.csproj

@@ -0,0 +1,15 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+	<PropertyGroup>
+		<TargetFramework>net10.0</TargetFramework>
+		<Nullable>enable</Nullable>
+		<ImplicitUsings>enable</ImplicitUsings>
+		<OpenApiGenerateDocuments>true</OpenApiGenerateDocuments>
+		<OpenApiGenerateDocumentsOptions>--openapi-version OpenApi3_0</OpenApiGenerateDocumentsOptions>
+	</PropertyGroup>
+
+	<ItemGroup>
+    <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="10.0.0-preview.3.25172.1" />
+    </ItemGroup>
+
+</Project>

aspnetcore/release-notes/aspnetcore-10/samples/WebAppOpenAPI10/WebAppOpenAPI10.http

@@ -0,0 +1,6 @@
+@WebAppOpenAPI10_HostAddress = http://localhost:5077
+
+GET {{WebAppOpenAPI10_HostAddress}}/weatherforecast/
+Accept: application/json
+
+###

aspnetcore/release-notes/aspnetcore-10/samples/WebAppOpenAPI10/appsettings.Development.json

@@ -0,0 +1,8 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  }
+}

aspnetcore/release-notes/aspnetcore-10/samples/WebAppOpenAPI10/appsettings.json

@@ -0,0 +1,9 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  },
+  "AllowedHosts": "*"
+}