Skip to content

Minimal Swashbuckle setup #1073

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 25 commits into from
Sep 8, 2021
Merged

Minimal Swashbuckle setup #1073

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
9798f4f
Add minimal Swashbuckle setup
maurei Sep 3, 2021
cf699c9
add tests, run ci build for openapi, use build props for openapi proj…
maurei Sep 6, 2021
f4cd2a3
review feedback
maurei Sep 6, 2021
dd3f794
CI clone_script fix
maurei Sep 6, 2021
efa98f5
review feedback
maurei Sep 6, 2021
901d2d0
fix CI build
maurei Sep 6, 2021
7d42f80
Merge branch 'openapi' into oa/minimal-setup
maurei Sep 6, 2021
64671c0
Reformat project files (using VS, doesn't appear to work in Rider)
Sep 7, 2021
e80478d
Fixed schema error in VS
Sep 7, 2021
204bcf9
reorder csproj
maurei Sep 7, 2021
a61d571
review feedback
maurei Sep 7, 2021
c0d4918
add SwaggerUI to example project
maurei Sep 7, 2021
fa448f5
rm redundant bit from dbcontext
maurei Sep 7, 2021
3aad466
add documentation
maurei Sep 7, 2021
bfab00f
typo
maurei Sep 7, 2021
8ab5b7c
remove redundant formatter instructions
maurei Sep 7, 2021
a46fc4d
review feedback
maurei Sep 7, 2021
5fc0afa
review feedback
maurei Sep 7, 2021
3a3c150
Merge branch 'openapi' into oa/minimal-setup
maurei Sep 7, 2021
71be36e
bump version
maurei Sep 7, 2021
e715d2b
updated swagger.json to pass test
maurei Sep 7, 2021
79f79dc
add nuget specification in project file, add sourcelink
maurei Sep 7, 2021
6c61da6
adjust buildscript
maurei Sep 7, 2021
c6e6e37
Add comment to AddOpenApi, introduced authors tag and build property …
maurei Sep 8, 2021
c236cad
Reformatted project file
Sep 8, 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
2 changes: 2 additions & 0 deletions Build.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,11 @@ function CreateNuGetPackage {

if ([string]::IsNullOrWhitespace($versionSuffix)) {
dotnet pack .\src\JsonApiDotNetCore -c Release -o .\artifacts
dotnet pack .\src\JsonApiDotNetCore.OpenApi -c Release -o .\artifacts
}
else {
dotnet pack .\src\JsonApiDotNetCore -c Release -o .\artifacts --version-suffix=$versionSuffix
dotnet pack .\src\JsonApiDotNetCore.OpenApi -c Release -o .\artifacts --version-suffix=$versionSuffix
}

CheckLastExitCode
Expand Down
2 changes: 1 addition & 1 deletion Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<AspNetCoreVersion>5.0.*</AspNetCoreVersion>
<EFCoreVersion>5.0.*</EFCoreVersion>
<NpgsqlPostgreSQLVersion>5.0.*</NpgsqlPostgreSQLVersion>
<SwashbuckleVersion>6.1.*</SwashbuckleVersion>
<SwashbuckleVersion>6.2.*</SwashbuckleVersion>
<CodeAnalysisRuleSet>$(MSBuildThisFileDirectory)CodingGuidelines.ruleset</CodeAnalysisRuleSet>
</PropertyGroup>

Expand Down
17 changes: 17 additions & 0 deletions src/JsonApiDotNetCore.OpenApi/JsonApiDotNetCore.OpenApi.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,30 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<VersionPrefix>4.2.0</VersionPrefix>
<TargetFramework>$(NetCoreAppVersion)</TargetFramework>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
</PropertyGroup>

<PropertyGroup>
<PackageTags>jsonapidotnetcore;jsonapi;json:api;dotnet;asp.net;openapi;swagger;swaggerui;swashbuckle</PackageTags>
<Description>A Swashbuckle integration that enables you to describe a JsonApiDotNetCore API with an OpenAPI specification.</Description>
<PackageProjectUrl>https://www.jsonapi.net/</PackageProjectUrl>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
<PublishRepositoryUrl>true</PublishRepositoryUrl>
<EmbedUntrackedSources>true</EmbedUntrackedSources>
<DebugType>embedded</DebugType>
</PropertyGroup>

<ItemGroup>
<ProjectReference Include="..\JsonApiDotNetCore\JsonApiDotNetCore.csproj" />
</ItemGroup>

<ItemGroup>
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="Swashbuckle.AspNetCore" Version="$(SwashbuckleVersion)" />
<PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="$(SwashbuckleVersion)" />
<PackageReference Include="Swashbuckle.AspNetCore.Newtonsoft" Version="$(SwashbuckleVersion)" />
Expand Down
2 changes: 1 addition & 1 deletion test/OpenApiTests/OpenApiDocumentTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public async Task Retrieved_document_matches_expected_document()
// Arrange
string embeddedResourceName = $"{nameof(OpenApiTests)}.swagger.json";
string expectedDocument = await LoadEmbeddedResourceAsync(embeddedResourceName);
string requestUrl = "swagger/v1/swagger.json";
const string requestUrl = "swagger/v1/swagger.json";

// Act
string actualDocument = await GetAsync(requestUrl);
Expand Down
2 changes: 1 addition & 1 deletion test/OpenApiTests/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.0.1",
"info": {
"title": "OpenApiTests",
"version": "1"
"version": "1.0"
},
"paths": {
"/airplanes": {
Expand Down