Refit : How to throw ApiException purposefully for specific status codes

Question

I'm trying to create Refit library for my APIs.

I wanted to throw ApiExeption whenever status code received is other than 200 and 207.

public interface IServiceAPIs{
     [Post("/api/users/register")]
     Task<HttpResponseMessage> PostData([Header]string auth,RegisterUserRequest registerUserRequest);
}

and in my implementation class:

try {
    var response = service.PostData(auth,registerUsers);
    if(!response.IsSuccessStatusCode){
        throw new ApiException(); // Here I'm not able to find how to throw this exception
    }
} catch(ApiException Ex) {
    log.write(ex);
}

How can I throw exception.?
Thanks in advance.

Answer 1

I just came across the similar requirement and solution is quite simple. If you use refit on client side every BadRequest is caught/handled as ApiException by Refit.

All you have to do is return return BadRequest("exception message") if you want to throw an exception within somewhere your Service or Repository when not in control. Do that by Throw new Exception("") (Exception should be AggregateException, NullException etc. not directly System.Exception), then catch this exception in your control like below and return BadRequest, this will be returned as ApiException on the client side.

your controller endpoint body.

         try
            {
                
                return Ok(response);
            }
            catch (Exception ex)
            {
                return BadRequest(ex.Message);
            }