Add support for JsonPolymorphic and JsonDerivedType attributes to Swashbuckle.AspNetCore.Annotations for .NET7 and later

[schnerring]

Beginning with .NET 7, System.Text.Json supports polymorphic type hierarchy serialization and deserialization with attribute annotations.

This PR adds support for JsonPolymorphic and JsonDerivedType attributes to Swashbuckle.AspNetCore.Annotations for .NET 7 and later.

Fixes #2571

[schnerring]

To fix the appveyor build, tests should be upgraded to net7 first. I'll rebase after related PR has been merged: #2672

[tomohisa]

This change would be great! @schnerring
Looking forward to use it in Swashbuckle.AspNetCore.Annotations

[martincostello]

Thanks for contributing - if you'd like to continue with this pull request, please rebase against the default branch to pick up our new CI. We'd also need tests for these new scenarios.

[github-actions]

This pull request is stale because it has been open for 60 days with no activity. It will be automatically closed in 14 days if no further changes are made.

[schnerring]

I rebased the PR against the current master branch.

The "test" (more of a sample) of the obsolete functionality is in here:

test/WebSites/NswagClientExample/Controllers/AnimalsController.cs

I've adjusted this to also include the new attributes.

Integration tests would be nice, but I'm not sure how to do that from scratch and would appreciate some input. We basically need to test if the OpenAPI spec is generated correctly. Is there a test harness inside the code base I could reuse?

[martincostello]

Integration tests would be nice, but I'm not sure how to do that from scratch and would appreciate some input. We basically need to test if the OpenAPI spec is generated correctly. Is there a test harness inside the code base I could reuse?

If you look at the Swashbuckle.AspNetCore.IntegrationTests project, it validates things through the sites in the WebSites folder. There are also verification tests associated with generated schemas here.

[ferhatmacak]

any progress?

[wont-work]

to anyone interested, it's possible to "manually" do what this PR does on your own code, until it gets merged: https://codeberg.org/KittyShopper/outpost/src/commit/3d8f0af997d3963ba552efe7ef9aec9b81d61a05/Outpost/Core/Util/OpenApi.cs#L135-L155

[schnerring]

any progress?

As I'm currently not using Swashbuckle and I'm busy with other things, I don't really have the time to dig into the code base and figure out how to test this. Any help would be appreciated.

[martincostello]

The preferred approach is to add a controller/endpoint to one of the test websites and then add appropriate verification tests to the integration test project to verify that the expected OpenAPI document is produced. There's various examples of that approach here.

[schnerring]

Sorry @martincostello, I didn't want you to have to repeat yourself. You already told me earlier where to find the integration tests. But as far as I can tell, the old polymorphism feature is also untested, so there is no way for me to copy any tests and work from there. I also added a (failing) test case for the NSwagClientExample to test if a valid Swagger doc is generated, but I have given up after an hour of debugging.

However, I implemented your other code review suggestions and rebased it to the current master. So maybe someone with more Swashbuckle expertise can pick up this PR in the future.

[Laurianti]

to anyone interested, it's possible to "manually" do what this PR does on your own code, until it gets merged: https://codeberg.org/KittyShopper/outpost/src/commit/3d8f0af997d3963ba552efe7ef9aec9b81d61a05/Outpost/Core/Util/OpenApi.cs#L135-L155

Yes, it works, could you fix and merge the PR please?

[martincostello]

Superseded by #3170.