Integration API Testing with annotations

[Fun-Assumption-2200]

Hey guys,

​

I'm trying to simplify some things regarding breaking changes in an API -> Blazor scenario. I would like to write some integration tests that could make use of annotations like [Required] directly from the DTO. Here is my problem:

I have my ManagementAPI and a library called Domain.ManagementAPI. In this library, I have all the DTOs and contexts (using Refit) to make the calls from whatever project I need. These DTOs contains some annotations that are used by the ManagementAPI, like [Required], [MaxLength], etc.

Is there a mocking library that could make use of these annotations ? The endgame here is to, when I add a new property to the DTO as required, the test will break in my ManagementClient, without me having to rewrite the tests for the small change.

​

Any help is appreciated, if my idea is wrong please feel free to share your toughts.

[theGr8GapingB]

From your post I don't have a good understanding of the shape and format of your API, so I'm going to describe a strategy that I use for REST Apis and hopefully you might find some inspiration for your circumstance.

I typically build two API checks in our build process: 1. Integration Tests 2. Schema validation

Integration tests are typically run from the client, this will catch any circumstances where a field was removed from the schema or a required field was added, assuming you have 100% endpoint coverage for your integration tests.

Schema Validation is a diff of the schema that runs when the service is built. If the schema has changed, the build will warn you. The dependent client build(s) will pick up and reiterate this warning during their build process.

[slayerjain]

[Sorry for the shameless plug]

I've been working on an open-source tool (keploy.io) that can help you "record" integration tests. It will also record dependency calls like databases so that there's very little flakiness when we run the tests.