Skip to content

Add xml comments to swagger #85

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

Merged
merged 5 commits into from
Apr 15, 2021
Merged

Add xml comments to swagger #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a8aba04
Add xml comments to swagger
StuartFerguson Apr 15, 2021
13d4617
Merge branch 'master' into task/#81_swaggerreview
StuartFerguson Apr 15, 2021
21af02c
Update nugets
StuartFerguson Apr 15, 2021
6cf81b4
Merge branch 'task/#81_swaggerreview' of ssh://github.com/StuartFergu…
StuartFerguson Apr 15, 2021
fabec12
fingers crossed :|
StuartFerguson Apr 15, 2021
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 TransactionProcessorACL.BusinessLogic/TransactionProcessorACL.BusinessLogic.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

<ItemGroup>
<PackageReference Include="MediatR" Version="9.0.0" />
<PackageReference Include="SecurityService.Client" Version="1.0.5" />
<PackageReference Include="SecurityService.Client" Version="1.0.5.1" />
<PackageReference Include="Shared" Version="1.0.5" />
<PackageReference Include="TransactionProcessor.Client" Version="1.0.11.1" />
<PackageReference Include="TransactionProcessor.Client" Version="1.0.11.2" />
</ItemGroup>

<ItemGroup>
Expand Down
4 changes: 4 additions & 0 deletions ...actionProcessorACL.DataTransferObjects/TransactionProcessorACL.DataTransferObjects.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
<TargetFrameworks>net5.0;netstandard2.0</TargetFrameworks>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(TargetFramework)|$(Platform)'=='Debug|net5.0|AnyCPU'">
<DocumentationFile>D:\Projects\StuartFerguson\TransactionProcessorACL\TransactionProcessorACL.DataTransferObjects\TransactionProcessorACL.DataTransferObjects.xml</DocumentationFile>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
</ItemGroup>
Expand Down
201 changes: 201 additions & 0 deletions TransactionProcessorACL.DataTransferObjects/TransactionProcessorACL.DataTransferObjects.xml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions TransactionProcessorACL.IntegrationTests/TransactionProcessorACL.IntegrationTests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,20 @@
<ItemGroup>
<PackageReference Include="ClientProxyBase" Version="1.0.5" />
<PackageReference Include="Ductus.FluentDocker" Version="2.7.3" />
<PackageReference Include="EstateManagement.Client" Version="1.0.9" />
<PackageReference Include="EstateManagement.Client" Version="1.0.9.2" />
<PackageReference Include="EstateReporting.Database" Version="1.0.12" />
<PackageReference Include="EventStore.Client.Grpc.PersistentSubscriptions" Version="20.10.0" />
<PackageReference Include="EventStore.Client.Grpc.ProjectionManagement" Version="20.10.0" />
<PackageReference Include="Grpc.Net.Client" Version="2.35.0" />
<PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="5.0.2" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.8.3" />
<PackageReference Include="SecurityService.Client" Version="1.0.5" />
<PackageReference Include="SecurityService.Client" Version="1.0.5.1" />
<PackageReference Include="Shared.IntegrationTesting" Version="1.0.5" />
<PackageReference Include="Shouldly" Version="4.0.3" />
<PackageReference Include="SpecFlow" Version="3.5.14" />
<PackageReference Include="SpecFlow.Tools.MsBuild.Generation" Version="3.5.14" />
<PackageReference Include="SpecFlow.xUnit" Version="3.5.14" />
<PackageReference Include="TransactionProcessor.Client" Version="1.0.11.1" />
<PackageReference Include="TransactionProcessor.Client" Version="1.0.11.2" />
<PackageReference Include="xunit" Version="2.4.1" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
<PrivateAssets>all</PrivateAssets>
Expand Down
2 changes: 1 addition & 1 deletion TransactionProcessorACL.Testing/TransactionProcessorACL.Testing.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="TransactionProcessor.Client" Version="1.0.11.1" />
<PackageReference Include="TransactionProcessor.Client" Version="1.0.11.2" />
</ItemGroup>

<ItemGroup>
Expand Down
10 changes: 10 additions & 0 deletions TransactionProcessorACL/Startup.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,16 @@ private void ConfigureMiddlewareServices(IServiceCollection services)
// add a custom operation filter which sets default values
c.OperationFilter<SwaggerDefaultValues>();
c.ExampleFilters();

//Locate the XML files being generated by ASP.NET...
var directory = new DirectoryInfo(AppContext.BaseDirectory);
var xmlFiles = directory.GetFiles("*.xml");

//... and tell Swagger to use those XML comments.
foreach (FileInfo fileInfo in xmlFiles)
{
c.IncludeXmlComments(fileInfo.FullName);
}
});

services.AddSwaggerExamplesFromAssemblyOf<SwaggerJsonConverter>();
Expand Down
4 changes: 4 additions & 0 deletions TransactionProcessorACL/TransactionProcessorACL.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
<DockerDefaultTargetOS>Linux</DockerDefaultTargetOS>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<DocumentationFile>D:\Projects\StuartFerguson\TransactionProcessorACL\TransactionProcessorACL\TransactionProcessorACL.xml</DocumentationFile>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="AspNetCore.HealthChecks.UI.Client" Version="5.0.1" />
<PackageReference Include="AspNetCore.HealthChecks.Uris" Version="5.0.1" />
Expand Down
Loading