Skip to content

[OpenAPI] Validate OpenAPI documents #63092

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[OpenAPI] Validate OpenAPI documents #63092

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/OpenApi/sample/Controllers/TestController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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; }
Expand Down
2 changes: 1 addition & 1 deletion src/OpenApi/src/Extensions/ApiDescriptionExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
};

Expand Down
33 changes: 29 additions & 4 deletions ...pi/test/Microsoft.AspNetCore.OpenApi.Tests/Integration/OpenApiDocumentIntegrationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand All @@ -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);
}
}
33 changes: 2 additions & 31 deletions ...enApiDocumentIntegrationTests.VerifyOpenApiDocument_documentName=controllers.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
],
"parameters": [
{
"name": "Id",
"name": "id",
"in": "path",
"required": true,
"schema": {
Expand All @@ -21,7 +21,7 @@
}
},
{
"name": "Name",
"name": "name",
"in": "path",
"required": true,
"schema": {
Expand Down Expand Up @@ -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": {
Expand Down
33 changes: 2 additions & 31 deletions ...enApiDocumentIntegrationTests.VerifyOpenApiDocument_documentName=controllers.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
],
"parameters": [
{
"name": "Id",
"name": "id",
"in": "path",
"required": true,
"schema": {
Expand All @@ -21,7 +21,7 @@
}
},
{
"name": "Name",
"name": "name",
"in": "path",
"required": true,
"schema": {
Expand Down Expand Up @@ -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": {
Expand Down
33 changes: 2 additions & 31 deletions .../snapshots/OpenApiDocumentLocalizationTests.VerifyOpenApiDocumentIsInvariant.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1165,7 +1165,7 @@
],
"parameters": [
{
"name": "Id",
"name": "id",
"in": "path",
"required": true,
"schema": {
Expand All @@ -1174,7 +1174,7 @@
}
},
{
"name": "Name",
"name": "name",
"in": "path",
"required": true,
"schema": {
Expand Down Expand Up @@ -1277,35 +1277,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": {
Expand Down
Loading