Skip to content

Add Microsoft.AspNetCore.OpenApi package #41197

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

Closed
captainsafia wants to merge 12 commits into from
Closed

Add Microsoft.AspNetCore.OpenApi package #41197

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
e41ed82
Add Microsoft.AspNetCore.OpenApi package
Mar 28, 2022
2b5cded
Add Microsoft.AspNetCore.OpenApi package
Mar 28, 2022
daa033b
Merge branch 'openapi-package' of https://github.com/captainsafia/asp…
Apr 11, 2022
5a9543a
Update branch
Apr 14, 2022
70db033
Clean up branch
captainsafia Apr 14, 2022
d715fd5
Merge branch 'main' into openapi-package
Apr 14, 2022
f601489
Clean up project file
Apr 15, 2022
84913ff
Remove new package from trimmable projects
Apr 15, 2022
a4ec6c6
Fix up schema type generation
Apr 15, 2022
e4da65d
Post review polish
Apr 18, 2022
cb7aafb
Add new package to templates
Apr 18, 2022
cbaaf1c
Split out SchemaGenerator
Apr 18, 2022
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
49 changes: 49 additions & 0 deletions AspNetCore.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1694,6 +1694,18 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "BuildAfterTargetingPack", "
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "BuildAfterTargetingPack", "src\BuildAfterTargetingPack\BuildAfterTargetingPack.csproj", "{8FED7E65-A7DD-4F13-8980-BF03E77B6C85}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{85520C50-CF33-4A27-BEC9-272100870D9D}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "OpenApi", "OpenApi", "{2D2D1107-7389-473B-BDCE-BFA060EAC453}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{E47D1385-64B3-429B-9B1D-B0D0B7B6E506}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{25642C23-0BB8-4FF7-9181-9599489679EB}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.AspNetCore.OpenApi", "src\Http\OpenApi\src\Microsoft.AspNetCore.OpenApi.csproj", "{EF5062E5-93FA-48B3-B8DB-7B7B263A64D4}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.AspNetCore.OpenApi.Tests", "src\Http\OpenApi\test\Microsoft.AspNetCore.OpenApi.Tests.csproj", "{77305727-1A53-402A-A4E8-4CFA0DBFACC6}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ResultsOfTGenerator", "src\Http\Http.Results\tools\ResultsOfTGenerator\ResultsOfTGenerator.csproj", "{9716D0D0-2251-44DD-8596-67D253EEF41C}"
EndProject
Global
Expand Down Expand Up @@ -10137,6 +10149,38 @@ Global
{8FED7E65-A7DD-4F13-8980-BF03E77B6C85}.Release|x64.Build.0 = Release|Any CPU
{8FED7E65-A7DD-4F13-8980-BF03E77B6C85}.Release|x86.ActiveCfg = Release|Any CPU
{8FED7E65-A7DD-4F13-8980-BF03E77B6C85}.Release|x86.Build.0 = Release|Any CPU
{EF5062E5-93FA-48B3-B8DB-7B7B263A64D4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{EF5062E5-93FA-48B3-B8DB-7B7B263A64D4}.Debug|Any CPU.Build.0 = Debug|Any CPU
{EF5062E5-93FA-48B3-B8DB-7B7B263A64D4}.Debug|arm64.ActiveCfg = Debug|Any CPU
{EF5062E5-93FA-48B3-B8DB-7B7B263A64D4}.Debug|arm64.Build.0 = Debug|Any CPU
{EF5062E5-93FA-48B3-B8DB-7B7B263A64D4}.Debug|x64.ActiveCfg = Debug|Any CPU
{EF5062E5-93FA-48B3-B8DB-7B7B263A64D4}.Debug|x64.Build.0 = Debug|Any CPU
{EF5062E5-93FA-48B3-B8DB-7B7B263A64D4}.Debug|x86.ActiveCfg = Debug|Any CPU
{EF5062E5-93FA-48B3-B8DB-7B7B263A64D4}.Debug|x86.Build.0 = Debug|Any CPU
{EF5062E5-93FA-48B3-B8DB-7B7B263A64D4}.Release|Any CPU.ActiveCfg = Release|Any CPU
{EF5062E5-93FA-48B3-B8DB-7B7B263A64D4}.Release|Any CPU.Build.0 = Release|Any CPU
{EF5062E5-93FA-48B3-B8DB-7B7B263A64D4}.Release|arm64.ActiveCfg = Release|Any CPU
{EF5062E5-93FA-48B3-B8DB-7B7B263A64D4}.Release|arm64.Build.0 = Release|Any CPU
{EF5062E5-93FA-48B3-B8DB-7B7B263A64D4}.Release|x64.ActiveCfg = Release|Any CPU
{EF5062E5-93FA-48B3-B8DB-7B7B263A64D4}.Release|x64.Build.0 = Release|Any CPU
{EF5062E5-93FA-48B3-B8DB-7B7B263A64D4}.Release|x86.ActiveCfg = Release|Any CPU
{EF5062E5-93FA-48B3-B8DB-7B7B263A64D4}.Release|x86.Build.0 = Release|Any CPU
{77305727-1A53-402A-A4E8-4CFA0DBFACC6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{77305727-1A53-402A-A4E8-4CFA0DBFACC6}.Debug|Any CPU.Build.0 = Debug|Any CPU
{77305727-1A53-402A-A4E8-4CFA0DBFACC6}.Debug|arm64.ActiveCfg = Debug|Any CPU
{77305727-1A53-402A-A4E8-4CFA0DBFACC6}.Debug|arm64.Build.0 = Debug|Any CPU
{77305727-1A53-402A-A4E8-4CFA0DBFACC6}.Debug|x64.ActiveCfg = Debug|Any CPU
{77305727-1A53-402A-A4E8-4CFA0DBFACC6}.Debug|x64.Build.0 = Debug|Any CPU
{77305727-1A53-402A-A4E8-4CFA0DBFACC6}.Debug|x86.ActiveCfg = Debug|Any CPU
{77305727-1A53-402A-A4E8-4CFA0DBFACC6}.Debug|x86.Build.0 = Debug|Any CPU
{77305727-1A53-402A-A4E8-4CFA0DBFACC6}.Release|Any CPU.ActiveCfg = Release|Any CPU
{77305727-1A53-402A-A4E8-4CFA0DBFACC6}.Release|Any CPU.Build.0 = Release|Any CPU
{77305727-1A53-402A-A4E8-4CFA0DBFACC6}.Release|arm64.ActiveCfg = Release|Any CPU
{77305727-1A53-402A-A4E8-4CFA0DBFACC6}.Release|arm64.Build.0 = Release|Any CPU
{77305727-1A53-402A-A4E8-4CFA0DBFACC6}.Release|x64.ActiveCfg = Release|Any CPU
{77305727-1A53-402A-A4E8-4CFA0DBFACC6}.Release|x64.Build.0 = Release|Any CPU
{77305727-1A53-402A-A4E8-4CFA0DBFACC6}.Release|x86.ActiveCfg = Release|Any CPU
{77305727-1A53-402A-A4E8-4CFA0DBFACC6}.Release|x86.Build.0 = Release|Any CPU
{9716D0D0-2251-44DD-8596-67D253EEF41C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{9716D0D0-2251-44DD-8596-67D253EEF41C}.Debug|Any CPU.Build.0 = Debug|Any CPU
{9716D0D0-2251-44DD-8596-67D253EEF41C}.Debug|arm64.ActiveCfg = Debug|Any CPU
Expand Down Expand Up @@ -10992,6 +11036,11 @@ Global
{B7DAA48B-8E5E-4A5D-9FEB-E6D49AE76A04} = {41BB7BA4-AC08-4E9A-83EA-6D587A5B951C}
{489020F2-80D9-4468-A5D3-07E785837A5D} = {017429CC-C5FB-48B4-9C46-034E29EE2F06}
{8FED7E65-A7DD-4F13-8980-BF03E77B6C85} = {489020F2-80D9-4468-A5D3-07E785837A5D}
{2D2D1107-7389-473B-BDCE-BFA060EAC453} = {627BE8B3-59E6-4F1D-8C9C-76B804D41724}
{E47D1385-64B3-429B-9B1D-B0D0B7B6E506} = {2D2D1107-7389-473B-BDCE-BFA060EAC453}
{25642C23-0BB8-4FF7-9181-9599489679EB} = {2D2D1107-7389-473B-BDCE-BFA060EAC453}
{EF5062E5-93FA-48B3-B8DB-7B7B263A64D4} = {E47D1385-64B3-429B-9B1D-B0D0B7B6E506}
{77305727-1A53-402A-A4E8-4CFA0DBFACC6} = {25642C23-0BB8-4FF7-9181-9599489679EB}
{9716D0D0-2251-44DD-8596-67D253EEF41C} = {323C3EB6-1D15-4B3D-918D-699D7F64DED9}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
Expand Down
1 change: 1 addition & 0 deletions eng/Dependencies.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ and are generated based on the last package release.
<LatestPackageReference Include="Microsoft.Win32.Registry" />
<LatestPackageReference Include="Microsoft.CodeAnalysis.CSharp.Analyzer.Testing.XUnit" />
<LatestPackageReference Include="Microsoft.CodeAnalysis.CSharp.CodeFix.Testing.XUnit" />
<LatestPackageReference Include="Microsoft.OpenApi" />
<LatestPackageReference Include="System.Buffers" />
<LatestPackageReference Include="System.CodeDom" />
<LatestPackageReference Include="System.CommandLine.Experimental" />
Expand Down
1 change: 1 addition & 0 deletions eng/ProjectReferences.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
<ProjectReferenceProvider Include="Microsoft.AspNetCore.Http.Results" ProjectPath="$(RepoRoot)src\Http\Http.Results\src\Microsoft.AspNetCore.Http.Results.csproj" />
<ProjectReferenceProvider Include="Microsoft.AspNetCore.Http" ProjectPath="$(RepoRoot)src\Http\Http\src\Microsoft.AspNetCore.Http.csproj" />
<ProjectReferenceProvider Include="Microsoft.AspNetCore.Metadata" ProjectPath="$(RepoRoot)src\Http\Metadata\src\Microsoft.AspNetCore.Metadata.csproj" />
<ProjectReferenceProvider Include="Microsoft.AspNetCore.OpenApi" ProjectPath="$(RepoRoot)src\Http\OpenApi\src\Microsoft.AspNetCore.OpenApi.csproj" />
<ProjectReferenceProvider Include="Microsoft.AspNetCore.Owin" ProjectPath="$(RepoRoot)src\Http\Owin\src\Microsoft.AspNetCore.Owin.csproj" />
<ProjectReferenceProvider Include="Microsoft.AspNetCore.Routing.Abstractions" ProjectPath="$(RepoRoot)src\Http\Routing.Abstractions\src\Microsoft.AspNetCore.Routing.Abstractions.csproj" />
<ProjectReferenceProvider Include="Microsoft.AspNetCore.Routing" ProjectPath="$(RepoRoot)src\Http\Routing\src\Microsoft.AspNetCore.Routing.csproj" />
Expand Down
1 change: 1 addition & 0 deletions eng/Versions.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,7 @@
<XUnitRunnerVisualStudioVersion>2.4.3</XUnitRunnerVisualStudioVersion>
<MicrosoftDataSqlClientVersion>4.0.1</MicrosoftDataSqlClientVersion>
<MicrosoftAspNetCoreAppVersion>6.0.0-preview.3.21167.1</MicrosoftAspNetCoreAppVersion>
<MicrosoftOpenApiVersion>1.2.3</MicrosoftOpenApiVersion>
</PropertyGroup>
<!-- Restore feeds -->
<PropertyGroup Label="Restore feeds">
Expand Down
10 changes: 9 additions & 1 deletion src/Http/HttpAbstractions.slnf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
"src\\Http\\Http\\src\\Microsoft.AspNetCore.Http.csproj",
"src\\Http\\Http\\test\\Microsoft.AspNetCore.Http.Tests.csproj",
"src\\Http\\Metadata\\src\\Microsoft.AspNetCore.Metadata.csproj",
"src\\Http\\OpenApi\\src\\Microsoft.AspNetCore.OpenApi.csproj",
"src\\Http\\OpenApi\\test\\Microsoft.AspNetCore.OpenApi.Tests.csproj",
"src\\Http\\Owin\\src\\Microsoft.AspNetCore.Owin.csproj",
"src\\Http\\Owin\\test\\Microsoft.AspNetCore.Owin.Tests.csproj",
"src\\Http\\Routing.Abstractions\\src\\Microsoft.AspNetCore.Routing.Abstractions.csproj",
Expand All @@ -40,18 +42,24 @@
"src\\Http\\WebUtilities\\perf\\Microbenchmarks\\Microsoft.AspNetCore.WebUtilities.Microbenchmarks.csproj",
"src\\Http\\WebUtilities\\src\\Microsoft.AspNetCore.WebUtilities.csproj",
"src\\Http\\WebUtilities\\test\\Microsoft.AspNetCore.WebUtilities.Tests.csproj",
"src\\Http\\samples\\MinimalSample\\MinimalSample.csproj",
"src\\Http\\samples\\SampleApp\\HttpAbstractions.SampleApp.csproj",
"src\\Middleware\\CORS\\src\\Microsoft.AspNetCore.Cors.csproj",
"src\\Middleware\\Diagnostics.Abstractions\\src\\Microsoft.AspNetCore.Diagnostics.Abstractions.csproj",
"src\\Middleware\\Diagnostics\\src\\Microsoft.AspNetCore.Diagnostics.csproj",
"src\\Middleware\\HostFiltering\\src\\Microsoft.AspNetCore.HostFiltering.csproj",
"src\\Middleware\\HttpOverrides\\src\\Microsoft.AspNetCore.HttpOverrides.csproj",
"src\\Middleware\\ResponseCaching.Abstractions\\src\\Microsoft.AspNetCore.ResponseCaching.Abstractions.csproj",
"src\\Middleware\\StaticFiles\\src\\Microsoft.AspNetCore.StaticFiles.csproj",
"src\\Mvc\\Mvc.Abstractions\\src\\Microsoft.AspNetCore.Mvc.Abstractions.csproj",
"src\\Mvc\\Mvc.Core\\src\\Microsoft.AspNetCore.Mvc.Core.csproj",
"src\\ObjectPool\\src\\Microsoft.Extensions.ObjectPool.csproj",
"src\\Security\\Authorization\\Core\\src\\Microsoft.AspNetCore.Authorization.csproj",
"src\\Security\\Authorization\\Policy\\src\\Microsoft.AspNetCore.Authorization.Policy.csproj",
"src\\Servers\\Connections.Abstractions\\src\\Microsoft.AspNetCore.Connections.Abstractions.csproj",
"src\\Servers\\IIS\\IISIntegration\\src\\Microsoft.AspNetCore.Server.IISIntegration.csproj",
"src\\Servers\\Kestrel\\Core\\src\\Microsoft.AspNetCore.Server.Kestrel.Core.csproj",
"src\\Servers\\Kestrel\\Kestrel\\src\\Microsoft.AspNetCore.Server.Kestrel.csproj",
"src\\Servers\\Kestrel\\Transport.Quic\\src\\Microsoft.AspNetCore.Server.Kestrel.Transport.Quic.csproj",
"src\\Servers\\Kestrel\\Transport.Sockets\\src\\Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.csproj",
"src\\Testing\\src\\Microsoft.AspNetCore.Testing.csproj",
"src\\WebEncoders\\src\\Microsoft.Extensions.WebEncoders.csproj"
Expand Down
25 changes: 25 additions & 0 deletions src/Http/OpenApi/src/Microsoft.AspNetCore.OpenApi.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>$(DefaultNetCoreTargetFramework)</TargetFramework>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<PackageTags>aspnetcore;openapi</PackageTags>

@dougbu dougbu Apr 14, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The package deserves a <Description>...</Description>. Otherwise people will need to guess its point from the package name and these tags. Suggest also adding more information to the commit and maybe the PR descriptions.

<Description>Provides APIs for annotating route handler endpoints in ASP.NET Core with OpenAPI annotations.</Description>
<Nullable>enable</Nullable>
</PropertyGroup>

<ItemGroup>
<Reference Include="Microsoft.OpenApi" />
<Reference Include="Microsoft.AspNetCore.Http.Abstractions" />
<Reference Include="Microsoft.AspNetCore.Routing" />
<Reference Include="Microsoft.AspNetCore.Mvc.Core" />

@Tratcher Tratcher Apr 14, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Organization question: Why put this under /Http/ when it depends on higher level components like MVC?

</ItemGroup>

<ItemGroup>
<Compile Include="$(SharedSourceRoot)RoslynUtils\TypeHelper.cs" LinkBase="Shared" />
<Compile Include="$(SharedSourceRoot)ObjectMethodExecutor\**\*.cs" LinkBase="Shared" />
<Compile Include="$(SharedSourceRoot)ParameterBindingMethodCache.cs" LinkBase="Shared" />
<Compile Include="$(SharedSourceRoot)TypeNameHelper\TypeNameHelper.cs" LinkBase="Shared" />
</ItemGroup>

</Project>
Loading