-
-
Notifications
You must be signed in to change notification settings - Fork 158
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.
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
Changes from 7 commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
9798f4f
Add minimal Swashbuckle setup
maurei cf699c9
add tests, run ci build for openapi, use build props for openapi proj…
maurei f4cd2a3
review feedback
maurei dd3f794
CI clone_script fix
maurei efa98f5
review feedback
maurei 901d2d0
fix CI build
maurei 7d42f80
Merge branch 'openapi' into oa/minimal-setup
maurei 64671c0
Reformat project files (using VS, doesn't appear to work in Rider)
e80478d
Fixed schema error in VS
204bcf9
reorder csproj
maurei a61d571
review feedback
maurei c0d4918
add SwaggerUI to example project
maurei fa448f5
rm redundant bit from dbcontext
maurei 3aad466
add documentation
maurei bfab00f
typo
maurei 8ab5b7c
remove redundant formatter instructions
maurei a46fc4d
review feedback
maurei 5fc0afa
review feedback
maurei 3a3c150
Merge branch 'openapi' into oa/minimal-setup
maurei 71be36e
bump version
maurei e715d2b
updated swagger.json to pass test
maurei 79f79dc
add nuget specification in project file, add sourcelink
maurei 6c61da6
adjust buildscript
maurei c6e6e37
Add comment to AddOpenApi, introduced authors tag and build property …
maurei c236cad
Reformatted project file
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,6 +15,7 @@ environment: | |
| branches: | ||
| only: | ||
| - master | ||
| - openapi | ||
| - develop | ||
| - unstable | ||
| - /release\/.+/ | ||
|
|
||
15 changes: 15 additions & 0 deletions
15
src/JsonApiDotNetCore.OpenApi/JsonApiDotNetCore.OpenApi.csproj
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <PropertyGroup> | ||
| <TargetFramework>$(NetCoreAppVersion)</TargetFramework> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Swashbuckle.AspNetCore" Version="$(SwashbuckleVersion)" /> | ||
| <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="$(SwashbuckleVersion)" /> | ||
| <PackageReference Include="Swashbuckle.AspNetCore.Newtonsoft" Version="$(SwashbuckleVersion)" /> | ||
| </ItemGroup> | ||
bart-degreed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\JsonApiDotNetCore\JsonApiDotNetCore.csproj" /> | ||
| </ItemGroup> | ||
bart-degreed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| </Project> | ||
19 changes: 19 additions & 0 deletions
19
src/JsonApiDotNetCore.OpenApi/OpenApiEndpointConvention.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| using System.Linq; | ||
| using Microsoft.AspNetCore.Mvc.ApplicationModels; | ||
| using Microsoft.AspNetCore.Mvc.Routing; | ||
|
|
||
| namespace JsonApiDotNetCore.OpenApi | ||
| { | ||
| internal sealed class OpenApiEndpointConvention : IActionModelConvention | ||
| { | ||
| public void Apply(ActionModel action) | ||
| { | ||
| ArgumentGuard.NotNull(action, nameof(action)); | ||
|
|
||
| if (!action.ActionMethod.GetCustomAttributes(true).OfType<HttpMethodAttribute>().Any()) | ||
| { | ||
| action.ApiExplorer.IsVisible = false; | ||
| } | ||
| } | ||
| } | ||
| } |
21 changes: 21 additions & 0 deletions
21
src/JsonApiDotNetCore.OpenApi/ServiceCollectionExtensions.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| using System; | ||
| using Microsoft.Extensions.DependencyInjection; | ||
| using Swashbuckle.AspNetCore.SwaggerGen; | ||
|
|
||
| namespace JsonApiDotNetCore.OpenApi | ||
| { | ||
| public static class ServiceCollectionExtensions | ||
| { | ||
| public static void AddOpenApi(this IServiceCollection services, IMvcCoreBuilder builder, Action<SwaggerGenOptions> setupSwaggerGenAction) | ||
bart-degreed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| ArgumentGuard.NotNull(services, nameof(services)); | ||
| ArgumentGuard.NotNull(builder, nameof(builder)); | ||
|
|
||
| builder.AddApiExplorer(); | ||
|
|
||
| builder.AddMvcOptions(options => options.Conventions.Add(new OpenApiEndpointConvention())); | ||
|
|
||
| services.AddSwaggerGen(setupSwaggerGenAction); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using JetBrains.Annotations; | ||
| using JsonApiDotNetCore.Resources; | ||
| using JsonApiDotNetCore.Resources.Annotations; | ||
|
|
||
| namespace OpenApiTests | ||
| { | ||
| [UsedImplicitly(ImplicitUseTargetFlags.Members)] | ||
| public sealed class Airplane : Identifiable | ||
| { | ||
| [Attr] | ||
| public int SeatingCapacity { get; set; } | ||
|
|
||
| [Attr] | ||
| public DateTimeOffset ManufacturedAt { get; set; } | ||
|
|
||
| [HasMany] | ||
| public ISet<Flight> Flights { get; set; } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| using JsonApiDotNetCore.Configuration; | ||
| using JsonApiDotNetCore.Controllers; | ||
| using JsonApiDotNetCore.Services; | ||
| using Microsoft.Extensions.Logging; | ||
|
|
||
| namespace OpenApiTests | ||
| { | ||
| public sealed class AirplanesController : JsonApiController<Airplane> | ||
| { | ||
| public AirplanesController(IJsonApiOptions options, ILoggerFactory loggerFactory, IResourceService<Airplane, int> resourceService) | ||
bart-degreed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| : base(options, loggerFactory, resourceService) | ||
| { | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| using System; | ||
| using JetBrains.Annotations; | ||
| using JsonApiDotNetCore.Resources; | ||
| using JsonApiDotNetCore.Resources.Annotations; | ||
|
|
||
| namespace OpenApiTests | ||
| { | ||
| [UsedImplicitly(ImplicitUseTargetFlags.Members)] | ||
| public sealed class Flight : Identifiable | ||
bart-degreed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| [Attr] | ||
| public string Destination { get; set; } | ||
|
|
||
| [Attr] | ||
| public DateTimeOffset DepartsAt { get; set; } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| using JsonApiDotNetCore.Configuration; | ||
| using JsonApiDotNetCore.Controllers; | ||
| using JsonApiDotNetCore.Services; | ||
| using Microsoft.Extensions.Logging; | ||
|
|
||
| namespace OpenApiTests | ||
| { | ||
| public sealed class FlightsController : JsonApiController<Flight> | ||
| { | ||
| public FlightsController(IJsonApiOptions options, ILoggerFactory loggerFactory, IResourceService<Flight> resourceService) | ||
| : base(options, loggerFactory, resourceService) | ||
| { | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| using JetBrains.Annotations; | ||
| using Microsoft.EntityFrameworkCore; | ||
|
|
||
| // @formatter:wrap_chained_method_calls chop_always | ||
| // @formatter:keep_existing_linebreaks true | ||
|
|
||
| namespace OpenApiTests | ||
| { | ||
| [UsedImplicitly(ImplicitUseTargetFlags.Members)] | ||
| public sealed class OpenApiDbContext : DbContext | ||
| { | ||
| public DbSet<Airplane> Airplanes { get; set; } | ||
| public DbSet<Flight> Flights { get; set; } | ||
|
|
||
| public OpenApiDbContext(DbContextOptions<OpenApiDbContext> options) | ||
| : base(options) | ||
| { | ||
| } | ||
|
|
||
| protected override void OnModelCreating(ModelBuilder builder) | ||
| { | ||
| builder.Entity<Airplane>() | ||
| .HasMany(airplane => airplane.Flights); | ||
| } | ||
bart-degreed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| using System; | ||
| using System.IO; | ||
| using System.Net.Http; | ||
| using System.Reflection; | ||
| using System.Threading.Tasks; | ||
| using FluentAssertions; | ||
| using TestBuildingBlocks; | ||
| using Xunit; | ||
|
|
||
| namespace OpenApiTests | ||
| { | ||
| public sealed class OpenApiDocumentTests : IntegrationTestContext<OpenApiStartup<OpenApiDbContext>, OpenApiDbContext> | ||
| { | ||
| public OpenApiDocumentTests() | ||
| { | ||
| UseController<AirplanesController>(); | ||
| UseController<FlightsController>(); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task Retrieved_document_should_match_expected_document() | ||
bart-degreed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| // Arrange | ||
| string embeddedResourceName = $"{nameof(OpenApiTests)}.openapi.json"; | ||
| string expectedDocument = await LoadEmbeddedResourceAsync(embeddedResourceName); | ||
| string requestUrl = $"swagger/{nameof(OpenApiTests)}/swagger.json"; | ||
bart-degreed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // Act | ||
| string actualDocument = await GetAsync(requestUrl); | ||
|
|
||
| // Assert | ||
| actualDocument.Should().BeJson(expectedDocument); | ||
| } | ||
|
|
||
| private async Task<string> GetAsync(string requestUrl) | ||
| { | ||
| var request = new HttpRequestMessage(HttpMethod.Get, requestUrl); | ||
|
|
||
| using HttpClient client = Factory.CreateClient(); | ||
| HttpResponseMessage responseMessage = await client.SendAsync(request); | ||
|
|
||
| return await responseMessage.Content.ReadAsStringAsync(); | ||
| } | ||
|
|
||
| private static async Task<string> LoadEmbeddedResourceAsync(string name) | ||
| { | ||
| var assembly = Assembly.GetExecutingAssembly(); | ||
| await using Stream stream = assembly.GetManifestResourceStream(name); | ||
|
|
||
| if (stream == null) | ||
| { | ||
| throw new Exception($"Failed to load embedded resource '{name}'. Set Build Action to Embedded Resource in properties."); | ||
| } | ||
|
|
||
| using var reader = new StreamReader(stream); | ||
| return await reader.ReadToEndAsync(); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| using JsonApiDotNetCore.Configuration; | ||
| using JsonApiDotNetCore.OpenApi; | ||
| using Microsoft.AspNetCore.Builder; | ||
| using Microsoft.AspNetCore.Hosting; | ||
| using Microsoft.EntityFrameworkCore; | ||
| using Microsoft.Extensions.DependencyInjection; | ||
| using Microsoft.Extensions.Logging; | ||
| using Microsoft.OpenApi.Models; | ||
| using TestBuildingBlocks; | ||
|
|
||
| namespace OpenApiTests | ||
| { | ||
| public sealed class OpenApiStartup<TDbContext> : TestableStartup<TDbContext> | ||
| where TDbContext : DbContext | ||
| { | ||
| public override void ConfigureServices(IServiceCollection services) | ||
| { | ||
| IMvcCoreBuilder mvcCoreBuilder = services.AddMvcCore(); | ||
|
|
||
| services.AddJsonApi<TDbContext>(SetJsonApiOptions, mvcBuilder: mvcCoreBuilder); | ||
|
|
||
| services.AddOpenApi(mvcCoreBuilder, options => options.SwaggerDoc(nameof(OpenApiTests), new OpenApiInfo | ||
| { | ||
| Title = nameof(OpenApiTests), | ||
| Version = "1" | ||
| })); | ||
| } | ||
|
|
||
| public override void Configure(IApplicationBuilder app, IWebHostEnvironment environment, ILoggerFactory loggerFactory) | ||
| { | ||
| app.UseRouting(); | ||
|
|
||
| app.UseJsonApi(); | ||
|
|
||
| app.UseSwagger(); | ||
|
|
||
| app.UseEndpoints(endpoints => endpoints.MapControllers()); | ||
bart-degreed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
bart-degreed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <PropertyGroup> | ||
bart-degreed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <TargetFramework>$(NetCoreAppVersion)</TargetFramework> | ||
| </PropertyGroup> | ||
|
|
||
bart-degreed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <ItemGroup> | ||
| <None Update="xunit.runner.json"> | ||
| <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory> | ||
| </None> | ||
| </ItemGroup> | ||
bart-degreed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\..\src\JsonApiDotNetCore.OpenApi\JsonApiDotNetCore.OpenApi.csproj" /> | ||
| <ProjectReference Include="..\TestBuildingBlocks\TestBuildingBlocks.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="coverlet.collector" Version="$(CoverletVersion)" PrivateAssets="All" /> | ||
| <PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" Version="$(AspNetCoreVersion)" /> | ||
| <PackageReference Include="Microsoft.NET.Test.Sdk" Version="$(TestSdkVersion)" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <EmbeddedResource Include="openapi.json" /> | ||
| </ItemGroup> | ||
bart-degreed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| </Project> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.