Как свести ответы сервисов к одной сущности asp net core web api?

Question

[fff ttt]

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

namespace OnlineStore.Domain.Response
{
    public class BaseResponse<T> : IBaseResponse<T>
    {
        public string Description { get; set; }
        public StatusCode StatusCode { get; set; }
        public T Data { get; set;}


    }

    public interface IBaseResponse<T> 
    {
        T Data { get; set; }   
    }
}

где StatusCode у меня ялвяется Enum такого вида(потом он станет больше):

namespace OnlineStore.Domain.Enum
{
    public enum StatusCode
    {
        OK = 200,
        NotContent=204,
        InternalServerError = 500
    }
}

И методы сервиса у меня бы работали примерно таким образом:

public async Task<IBaseResponse<Product>> GetProductById(int id) { 
            var response = new BaseResponse<Product>();
            try
            {
                var product = await _productRepository.GetById(id);
                if (product == null) 
                {
                    response.Description = $"There is no product with this id: {id}";
                    response.StatusCode = StatusCode.NotContent;
                    return response;
                }
                response.Data = product;
                return response;
            }
            catch (Exception ex)
            {
                return new BaseResponse<Product>()
                {
                    Description = $"[GetProducts]: {ex.Message}",
                    StatusCode = StatusCode.InternalServerError
                };
            }
        }

И вот я хочу чтобы все сервисы возвращали в контроллер объект IBaseResponse и потом я просто создавал объект IActionResult, данные для которого я бы брал из этого объекта.Как мне реализовать метод, который будет брать IBaseResponse и возвращать IActionResult беря данные из объекта вернувшегося из сервиса. Объясните мне как лучше реализовывать такие вещи например в слоистой архитектуре приложения или как еще можно

Comments

[Andrei SunnyPh]

Можете попробовать самостоятельно создать стандартный ответ из API.
Например:

public class APIResponse
    {
        public APIResponse()
        {
            ErrorMessages = new List<string>();
        }
        public HttpStatusCode StatusCode { get; set; }
        public bool IsSuccess { get; set; } = true;
        public List<string> ErrorMessages { get; set; }
        public object Result { get; set; }
    }

И такой объект, будет содержать статус код, признак того обработан ли успешно запрос,
список возможных ошибок и собственно сам результат ответа.

Далее, ваш метод мог бы выглядеть так, с использованием этого стандартного ответа:

public async Task<ActionResult<APIResponse>> GetProductById(int id)
        {
            try
            {
                if (id == 0)
                {
                    _response.StatusCode = HttpStatusCode.BadRequest;
                    return BadRequest(_response);
                }
               var product = await _productRepository.GetById(id);
                if (product == null)
                {
                    _response.StatusCode = HttpStatusCode.NotFound;
                    return NotFound(_response);
                }
                _response.Result = product;
                _response.StatusCode = HttpStatusCode.OK;
                return Ok(_response);
            }
            catch (Exception ex)
            {
                _response.IsSuccess = false;
                _response.ErrorMessages
                     = new List<string>() { ex.ToString() };
            }
            return _response;
        }

Пример реализации такого подхода для WEB API в репозитории.

Answer 1

[Сергей Соловьев]

Зачем везде возвращать IBaseResponse? В нем описание и статус код - они повторяют HTTP метод работы. Разницы между ними никакой. Это явное протекание абстракций.
Лучше сделать так:
1. В контроллере вызываешь GetProductById.
2. Если вернул null, то создаешь ответ 404 There is not product with this id
3. Если возникла ошибка - возвращаешь 500
4. В противном случае возвращаешь ответ

Не смешивай логику и представление

Comments

[fff ttt]

я понимаю что тут эта реализация лишняя, но я пока только учусь и просто подумал как бы было мне удобнее если у меня было бы много разных вариантов ответа и вот так вот проверять "если это, то вернуть это" мне не особо нравится, и это выглядит для меня буквально как решение в лоб, я хочу попробовать сделал что-то более такое общее, куда более удобнее возвращать в таких ситуациях какой-то один объект и по нему составлять ответ, чем проверки эти

[Сергей Соловьев]

Для подобного можно использовать исключения - сделай отдельные MVC фильтры: IResourceFilter, IExceptionFilter и т.д. Если исключение - возвращай ответ с исключением. Если null - 404. Иначе обычный ответ

[fff ttt]

Сергей Соловьев, а можно пример или ссылку на статью пожалуйста, я еще не оч плаваю в терминологии не знаю, что под этим подразумевается. Но в моей голове выглядело красиво, что я возвращаю один объект шаблонный, и потом создаю по его данным объект ответа и возвращаю его, ведь по сути же большинство ответов имеют только три основных информативных поля - status, data, и возможно message с подробной информацией

[Сергей Соловьев]

https://metanit.com/sharp/aspnetmvc/10.1.php