feat: extending ApiBehaviorOptions with skip SkipStatusCodePages

[onurkanbakirci]

Extending ApiBehaviorOptions with skip SkipStatusCodePages

I added a SkipStatusCodePages property to the ApiBehaviorOptions class to extend its functionality. I then referenced the new SkipStatusCodePagesConvention from the ApiBehaviorApplicationModelProvider class. The SkipStatusCodePagesConvention class adds a SkipStatusCodePagesAttribute to the API controller to disable the skip status code pages feature.

However, I am encountering the following reference error:

error CS0246: The type or namespace name ‘SkipStatusCodePagesAttribute’ could not be found (are you missing a using directive or an assembly reference?)

What could be causing this problem, and how can I resolve it? What might I be missing?

Fixes #45369 , #45260

[martincostello]

What could be causing this problem

SkipStatusCodePagesAttribute is defined in Microsoft.AspNetCore.Mvc.ViewFeatures, which Microsoft.AspNetCore.Mvc.Core is a dependency of. You can't depend on it because it would create a circular reference.

Unless the attribute definition were moved down the stack from ViewFeatures to Core, you'll need to define an private implementation of ISkipStatusCodePagesMetadata within Core and use that in the convention.

[onurkanbakirci]

Thanks for your response @martincostello. Do you think creating a private ISkipStatusCodePagesMetadata interface within Microsoft.AspNetCore.Mvc.Core is a good option, or should I consider different strategies?

[martincostello]

The only options are to create a private implementation of the interface and use that or for the implementation to be moved to a lower level of the stack. The latter would need approval from the team to move and would need type-forwarding to be set up.

[captainsafia]

@onurkanbakirci Martin's recommendation for a private implementation of the interface is spot on. It's the general pattern we use for these things. That should allow you to resolve the issue without introducing circular dependencies or requiring another round of API review.

[dotnet-policy-service]

Looks like this PR hasn't been active for some time and the codebase could have been changed in the meantime.
To make sure no conflicting changes have occurred, please rerun validation before merging. You can do this by leaving an /azp run comment here (requires commit rights), or by simply closing and reopening.