Как вернуть тот же код состояния из второго вызова API - PullRequest
Новая
       29

Как вернуть тот же код состояния из второго вызова API

3 голосов
/ 30 января 2020

У меня есть ASP. NET Core API, вызывающий второй API.

Я выбрасываю исключение на своем уровне служб, если возникает ошибка второго API: 

var response = await httpClient.SendAsync(request); //call second API

if (!response.IsSuccessStatusCode)
{
    //return HTTP response with StatusCode = X, if response.StatusCode == X
    throw new HttpRequestException(await response.Content.ReadAsStringAsync()); 
    //this always returns 400
}

Как я могу выдать исключение, которое возвратит ответ с тем же кодом состояния от второго вызова API?

Если я использую HttpRequestException, он всегда вернет 400, даже если response объект имел StatusCode = 500.

РЕДАКТИРОВАТЬ: Первая конечная точка API выглядит следующим образом: 

            public async Task<ActionResult<HttpResponseMessage>> CreateTenancy([FromBody]TenancyRequest tenancy)
            {
                //Make some calls...
                return Created(string.Empty, new { TenancyID = newTenancyExternalId });
            }

Вторая конечная точка API выглядит следующим образом: 

    [HttpPost]
    public IHttpActionResult CreateTenancy([FromBody]TenancyDTO tenancyDTO)
    {    
        var tenancy = GetTenancy();    
        return Created(string.Empty, tenancy);
    }

Я пытался использовать throw new HttpResponseException(response);, но это удаляет описательное сообщение об исключении, полезная нагрузка заканчивается следующим образом: 

{
    "Code": 500,
    "CorrelationId": "2df08016-e5e3-434a-9136-6824495ed907",
    "DateUtc": "2020-01-30T02:02:48.4428978Z",
    "ErrorMessage": "Processing of the HTTP request resulted in an exception. Please see the HTTP response returned by the 'Response' property of this exception for details.",
    "ErrorType": "InternalServerError"
}

Я хотел бы сохранить значение ErrorMessage в исходном полезная нагрузка: 

{
    "Code": 400,
    "CorrelationId": "ff9466b4-8c80-4dab-b5d7-9bba1355a567",
    "DateUtc": "2020-01-30T03:05:13.2397543Z",
    "ErrorMessage": "\"Specified cast is not valid.\"",
    "ErrorType": "BadRequest"
}

Конечная цель - вернуть это значение: 

{
    "Code": 500,
    "CorrelationId": "ff9466b4-8c80-4dab-b5d7-9bba1355a567",
    "DateUtc": "2020-01-30T03:05:13.2397543Z",
    "ErrorMessage": "\"Specified cast is not valid.\"",
    "ErrorType": "InternalServerError"
}

Ответы [ 3 ]

2 голосов
/ 30 января 2020

Я попытался сделать что-то простое, например, изменить тип возвращаемого значения конечной точки API и вернуть объект таким, какой он есть, в случае ошибки. В противном случае создайте свой собственный HttpResponseMessage и верните его. Этот фрагмент ниже использует текст, но вы можете использовать сериализатор для сериализации другого контента, если у вас есть. 

public async Task<HttpResponseMessage> Test(string str)
{
    var httpClient = new HttpClient();
    var request = new HttpRequestMessage(HttpMethod.Get, $"myAPI that returns different errors 400, 404, 500 etc based on str");

    var response = await httpClient.SendAsync(request);
    if (!response.IsSuccessStatusCode)
        return response;

    // do something else
    return new HttpResponseMessage(System.Net.HttpStatusCode.OK) { Content = new StringContent("Your Text here") };
}

Другой подход использования фильтров

Другой При использовании IHttpActionResult в качестве типа возвращаемого значения вы можете использовать фильтры, чтобы согласовать все ваши HttpResponseMessages с IHttpActionResult.

Filter: Создать отдельный файл cs и использовать это определение фильтра. 

public class CustomObjectResponse : IHttpActionResult
{
    private readonly object _obj;

    public CustomObjectResponse(object obj)
    {
        _obj = obj;
    }

    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
    {
        HttpResponseMessage response = _obj as HttpResponseMessage;
        return Task.FromResult(response);
    }
}

и в вашем API вы будете использовать свой фильтр следующим образом: 

public async Task<IHttpActionResult> Test(string str)
{
    var httpClient = new HttpClient();
    var request = new HttpRequestMessage(HttpMethod.Get, $"http://localhost:4500/api/capacity/update-mnemonics/?mnemonic_to_update={str}");

    var response = await httpClient.SendAsync(request);
    if (!response.IsSuccessStatusCode)
        return new CustomObjectResponse(response);

    // Other Code here

    // Return Other objects 
    KeyValuePair<string, string> testClass = new KeyValuePair<string, string>("Sheldon", "Cooper" );
    return new OkWithObjectResult(testClass);

    // Or Return Standard HttpResponseMessage
    return Ok();

}
1 голос
/ 30 января 2020

Вы можете просто сделать свой вызов API и скопировать его код ответа во что-нибудь, совместимое с IStatusCodeActionResult.

Альтернативой s для создания пользовательского исключения. Создайте что-то вроде 

public class ApiCallException : Exception
{
    public APiCallException(int statusCode, ...)
    {
        ApiStatusCode = statusCode;
    }

    int ApiStatusCode { get; }
    ...
}

и скопируйте код состояния из вашего результата API, а затем сгенерируйте исключение. 

var response = await httpClient.SendAsync(request); //call second API
if (!response.IsSuccessStatusCode)
{   
    var content = await response.Content.ReadAsStringAsync();
    throw new ApiCallException(500, content); 
}

Затем можно зарегистрировать фильтр исключений для обработки результата. при вызове AddMvc. 

services.AddMvc(options => options.Filters.Add<ExceptionFilter>());

, где ExceptionFilter может быть что-то вроде 

public class ExceptionFilter : IExceptionFilter
{
    // ...

    public void OnException(ExceptionContext context)
    {
        if (context.Exception is ApiCallException ace)
        {
            var returnObject = CreateReturnObjectSomehow();
            context.Result = new ObjectResult(returnObject) { StatusCode = ace.StatusCode };
        }
        else
        {
            // do something else
        }
    }
}
0 голосов
/ 31 января 2020

Спасибо Jawad и Kit за отличные ответы, которые помогли мне найти решение, приведенное ниже:

Оказалось, что было какое-то промежуточное ПО, обрабатывающее исключение: 

    public async Task Invoke(HttpContext httpContext)
    {
        try
        {
            await _next(httpContext);
        }
        catch (Exception exception)
        {
            if (httpContext.Response.HasStarted) throw;

            var statusCode = ConvertExceptionToHttpStatusCode(exception);

            httpContext.Response.Clear();
            httpContext.Response.StatusCode = (int)statusCode;
            httpContext.Response.ContentType = "application/json";

            if (statusCode != HttpStatusCode.BadRequest)
            {
                _logger.Error(exception, "API Error");
            }

            await httpContext.Response.WriteAsync(JsonConvert.SerializeObject(new Error(statusCode, httpContext.Request.CorrelationId(), exception.Message, statusCode.ToString())));
        }
    }

Класс Error выглядит следующим образом: 

    public class Error
    {
        public int Code { get; }
        public Guid? CorrelationId { get; }
        public DateTime DateUtc { get; }
        public string ErrorMessage { get; }
        public string ErrorType { get; }

        public Error(HttpStatusCode code, Guid? correlationId, string errorMessage, string errorType)
        {
            Code = (int)code;
            CorrelationId = correlationId;
            DateUtc = DateTime.UtcNow;
            ErrorMessage = errorMessage;
            ErrorType = errorType;
        }
    }

Я создал этот класс: 

public class ApiCallException : Exception
{
    public int StatusCode { get; }
    public override string Message { get; }
    public ApiCallException(int statusCode, string message)
    {
        StatusCode = statusCode;
        Message = message;
    }
}

Затем обновил мой исходный код, чтобы иметь это: 

                if (!response.IsSuccessStatusCode)
                {
                    throw new ApiCallException((int)response.StatusCode, await response.Content.ReadAsStringAsync());
                }
...