Add Microsoft.AspNetCore.OpenApi package #41238
Conversation
Fix up schema type generation Post review polish Add new package to templates Split out SchemaGenerator Clean up usings
captainsafia
requested review from
javiercn,
a team,
Tratcher,
BrennanConroy,
halter73,
dougbu,
wtgodbe and
Pilchie
as code owners
captainsafia
requested review from
a team
and removed request for
a team,
halter73,
Pilchie,
Tratcher,
dougbu,
javiercn,
BrennanConroy and
wtgodbe
|
|
||
| var hostEnvironment = serviceProvider.GetService<IHostEnvironment>(); | ||
| var serviceProviderIsService = serviceProvider.GetService<IServiceProviderIsService>(); | ||
| var generator = new OpenApiGenerator(hostEnvironment, serviceProviderIsService); |
There was a problem hiding this comment.
Now that OpenApiGenerator is no longer a singleton that's resolved from DI does it need to be refactored to make better use of its ParameterBindingMethodCache instance, etc.? e.g. RequestDelegateFactory creates a static instance of ParameterBindingMethodCache. That said, given this is in a package it might not be feasible to share the instance without making the type public anyway.
There was a problem hiding this comment.
Yeah, the addition of this package certainly ups the case for #33644 and introduces the additional challenge of this particular codepath needing to return ParameterLocation instead of BindingSource.
At least for all the complex types, the new IProvidesMetadata stuff might help a bit but not sure what to do about primitives.
Pilchie
added
the
area-web-frameworks
src/Http/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests.csproj
Outdated
Show resolved
Hide resolved
src/ProjectTemplates/Web.ProjectTemplates/content/WebApi-CSharp/Program.cs
Outdated
Show resolved
Hide resolved
| var discoveredTypeAnnotation = responseMetadata.Type; | ||
| var discoveredContentTypeAnnotation = new MediaTypeCollection(); | ||
|
|
||
| if (discoveredTypeAnnotation == typeof(void)) |
There was a problem hiding this comment.
Is this needed? Looks like we check null or void shortly below and set to responseType then.
There was a problem hiding this comment.
Yeah, this isn't needed. It exists as a legacy from the ApiExplorer days where == typeof(void) was used to handle scenarios where the return type was not provided by the user via an attribute, in which case, we would only fall back to the defined responseType on a 2xx status code.
However, that was coupled with some weirdness in the way that content types were handled in
Anyhoo, I was going to clean this up in a follow-up commit had I gotten any feedback in addition to this on the PR but I'll do this as part of #41243 instead.
captainsafia
requested review from
halter73,
DamianEdwards,
Tratcher,
dougbu and
brunolins16
ghost
added this to the 
Close #40676
ServiceProvidertoEndpointBuilderabstract classWithOpenApi()extension method toRouteHandlerBuilderWithOpenApi(Func<OpenApiOperation, OpenApiOperation> modifyOperation)extension method toRouteHandlerBuilderSchemaGeneratorto OpenApi package