[OpenAPI] Validate OpenAPI documents

- Validate OpenAPI documents with Microsoft.OpenApi.
- Exclude HTTP QUERY endpoints.
- Fix incorrect parameter casing.

Relates to #63090.

Author: martincostello

src/OpenApi/sample/Controllers/TestController.cs

@@ -60,10 +60,10 @@ public class HttpFoo() : HttpMethodAttribute(["FOO"]);
 
     public class RouteParamsContainer
     {
-        [FromRoute]
+        [FromRoute(Name = "id")]
         public int Id { get; set; }
 
-        [FromRoute]
+        [FromRoute(Name = "name")]
         [MinLength(5)]
         [UnconditionalSuppressMessage("Trimming", "IL2026:RequiresUnreferencedCode", Justification = "MinLengthAttribute works without reflection on string properties.")]
         public string? Name { get; set; }

src/OpenApi/src/Extensions/ApiDescriptionExtensions.cs

@@ -28,7 +28,7 @@ internal static class ApiDescriptionExtensions
             "HEAD" => HttpMethod.Head,
             "OPTIONS" => HttpMethod.Options,
             "TRACE" => HttpMethod.Trace,
-            "QUERY" => HttpMethod.Query,
+            "QUERY" => null, // OpenAPI as of 3.1 does not yet support HTTP QUERY
             _ => null,
         };
 

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Integration/OpenApiDocumentIntegrationTests.cs

@@ -36,10 +36,7 @@ public static TheoryData<string, OpenApiSpecVersion> OpenApiDocuments()
     [MemberData(nameof(OpenApiDocuments))]
     public async Task VerifyOpenApiDocument(string documentName, OpenApiSpecVersion version)
     {
-        var documentService = fixture.Services.GetRequiredKeyedService<OpenApiDocumentService>(documentName);
-        var scopedServiceProvider = fixture.Services.CreateScope();
-        var document = await documentService.GetOpenApiDocumentAsync(scopedServiceProvider.ServiceProvider);
-        var json = await document.SerializeAsJsonAsync(version);
+        var json = await GetOpenApiDocument(documentName, version);
         var baseSnapshotsDirectory = SkipOnHelixAttribute.OnHelix()
             ? Path.Combine(Environment.GetEnvironmentVariable("HELIX_WORKITEM_ROOT"), "Integration", "snapshots")
             : "snapshots";
@@ -48,4 +45,32 @@ await Verify(json)
             .UseDirectory(outputDirectory)
             .UseParameters(documentName);
     }
+
+    [Theory]
+    [MemberData(nameof(OpenApiDocuments))]
+    public async Task OpenApiDocumentIsValid(string documentName, OpenApiSpecVersion version)
+    {
+        var json = await GetOpenApiDocument(documentName, version);
+
+        var actual = OpenApiDocument.Parse(json, format: "json");
+
+        Assert.NotNull(actual);
+        Assert.NotNull(actual.Document);
+        Assert.NotNull(actual.Diagnostic);
+        Assert.NotNull(actual.Diagnostic.Errors);
+        Assert.Empty(actual.Diagnostic.Errors);
+
+        var ruleSet = ValidationRuleSet.GetDefaultRuleSet();
+
+        var errors = actual.Document.Validate(ruleSet);
+        Assert.Empty(errors);
+    }
+
+    private async Task<string> GetOpenApiDocument(string documentName, OpenApiSpecVersion version)
+    {
+        var documentService = fixture.Services.GetRequiredKeyedService<OpenApiDocumentService>(documentName);
+        var scopedServiceProvider = fixture.Services.CreateScope();
+        var document = await documentService.GetOpenApiDocumentAsync(scopedServiceProvider.ServiceProvider);
+        return await document.SerializeAsJsonAsync(version);
+    }
 }

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Integration/snapshots/OpenApi3_0/OpenApiDocumentIntegrationTests.VerifyOpenApiDocument_documentName=controllers.verified.txt

@@ -12,7 +12,7 @@
         ],
         "parameters": [
           {
-            "name": "Id",
+            "name": "id",
             "in": "path",
             "required": true,
             "schema": {
@@ -21,7 +21,7 @@
             }
           },
           {
-            "name": "Name",
+            "name": "name",
             "in": "path",
             "required": true,
             "schema": {
@@ -124,35 +124,6 @@
           }
         }
       }
-    },
-    "/query": {
-      "query": {
-        "tags": [
-          "Test"
-        ],
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "text/plain": {
-                "schema": {
-                  "$ref": "#/components/schemas/CurrentWeather"
-                }
-              },
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/CurrentWeather"
-                }
-              },
-              "text/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/CurrentWeather"
-                }
-              }
-            }
-          }
-        }
-      }
     }
   },
   "components": {

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Integration/snapshots/OpenApi3_1/OpenApiDocumentIntegrationTests.VerifyOpenApiDocument_documentName=controllers.verified.txt

@@ -12,7 +12,7 @@
         ],
         "parameters": [
           {
-            "name": "Id",
+            "name": "id",
             "in": "path",
             "required": true,
             "schema": {
@@ -21,7 +21,7 @@
             }
           },
           {
-            "name": "Name",
+            "name": "name",
             "in": "path",
             "required": true,
             "schema": {
@@ -124,35 +124,6 @@
           }
         }
       }
-    },
-    "/query": {
-      "query": {
-        "tags": [
-          "Test"
-        ],
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "text/plain": {
-                "schema": {
-                  "$ref": "#/components/schemas/CurrentWeather"
-                }
-              },
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/CurrentWeather"
-                }
-              },
-              "text/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/CurrentWeather"
-                }
-              }
-            }
-          }
-        }
-      }
     }
   },
   "components": {

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Integration/snapshots/OpenApiDocumentLocalizationTests.VerifyOpenApiDocumentIsInvariant.verified.txt

@@ -1143,7 +1143,7 @@
         ],
         "parameters": [
           {
-            "name": "Id",
+            "name": "id",
             "in": "path",
             "required": true,
             "schema": {
@@ -1152,7 +1152,7 @@
             }
           },
           {
-            "name": "Name",
+            "name": "name",
             "in": "path",
             "required": true,
             "schema": {
@@ -1255,35 +1255,6 @@
           }
         }
       }
-    },
-    "/query": {
-      "query": {
-        "tags": [
-          "Test"
-        ],
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "text/plain": {
-                "schema": {
-                  "$ref": "#/components/schemas/CurrentWeather"
-                }
-              },
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/CurrentWeather"
-                }
-              },
-              "text/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/CurrentWeather"
-                }
-              }
-            }
-          }
-        }
-      }
     }
   },
   "components": {