É necessário registrar o corpo da solicitação e resposta do asp.net webapi 2 em um banco de dados

Estou usando o Microsoft Asp.net WebApi2 hospedado no IIS. Eu gostaria muito simplesmente de registrar o corpo da solicitação (XML ou JSON) e o corpo da resposta para cada postagem.

Não há nada de especial neste projeto ou no controlador que processa a postagem. Não estou interessado em usar estruturas de registro como nLog, elmah, log4net ou os recursos de rastreamento integrados da API da web, a menos que seja necessário fazer isso.

Estou simplesmente querendo saber onde colocar meu código de registro e como obter o JSON ou XML real da solicitação e resposta de entrada e saída.

Meu método de postagem do controlador:

public HttpResponseMessage Post([FromBody])Employee employee)
{
   if (ModelState.IsValid)
   {
      // insert employee into to the database
   }

}

Eu recomendaria usar um DelegatingHandler. Então você não precisará se preocupar com nenhum código de registro em seus controladores.

public class LogRequestAndResponseHandler : DelegatingHandler
{
    protected override async Task<HttpResponseMessage> SendAsync(
        HttpRequestMessage request, CancellationToken cancellationToken)
    {
        if (request.Content != null)
        {
            // log request body
            string requestBody = await request.Content.ReadAsStringAsync();
            Trace.WriteLine(requestBody);
        }
        // let other handlers process the request
        var result = await base.SendAsync(request, cancellationToken);

        if (result.Content != null)
        {
            // once response body is ready, log it
            var responseBody = await result.Content.ReadAsStringAsync();
            Trace.WriteLine(responseBody);
        }

        return result;
    }
}

Basta substituir Trace.WriteLinepor seu código de registro e registrar o manipulador WebApiConfigassim:

config.MessageHandlers.Add(new LogRequestAndResponseHandler());

Aqui está a documentação completa da Microsoft para manipuladores de mensagens .

Existem várias abordagens para lidar genericamente com o registro de Solicitação / Resposta para todas as chamadas de método WebAPI:

1. ActionFilterAttribute: Pode-se escrever ActionFilterAttributemétodos personalizados e decorar os métodos de controle / ação para habilitar o registro.

   Contra: Você precisa decorar cada controlador / método (ainda pode fazer isso no controlador de base, mas ainda não aborda questões transversais.

2. Substitua BaseControllere controle o registro lá.

   Contra: Estamos esperando / forçando os controladores a herdar de um controlador de base personalizado.

3. Usando DelegatingHandler.

   Vantagem: Não estamos mexendo no controlador / método aqui com esta abordagem. O manipulador de delegação fica isolado e trata perfeitamente o registro de solicitações / respostas.

Para obter mais artigos detalhados, consulte este http://weblogs.asp.net/fredriknormen/log-message-request-and-response-in-asp-net-webapi .

Uma das opções que você tem é criar um filtro de ação e decorar seu WebApiController / ApiMethod com ele.

Atributo de filtro

public class MyFilterAttribute : System.Web.Http.Filters.ActionFilterAttribute
    {
        public override void OnActionExecuting(HttpActionContext actionContext)
        {
            if (actionContext.Request.Method == HttpMethod.Post)
            {
                var postData = actionContext.ActionArguments;
                //do logging here
            }
        }
    }

Controlador WebApi

[MyFilterAttribute]
public class ValuesController : ApiController{..}

ou

[MyFilterAttribute]
public void Post([FromBody]string value){..}

Espero que isto ajude.

Obter acesso para solicitar mensagem é fácil. Sua classe baseApiController contém .Requestpropriedade que, como o nome sugere, contém a solicitação na forma analisada. Você simplesmente examina o que deseja registrar e passa para a sua instalação de registro, seja ele qual for. Este código você pode colocar no início de sua ação, se precisar fazê-lo por apenas um ou um punhado.

Se você precisa fazer isso em todas as ações (todas significando mais do que um punhado gerenciável), então o que você pode fazer é substituir o .ExecuteAsyncmétodo para capturar cada chamada de ação para seu controlador.

public override Task<HttpResponseMessage> ExecuteAsync(
    HttpControllerContext controllerContext,
    CancellationToken cancellationToken
)
{
    // Do logging here using controllerContext.Request
    return base.ExecuteAsync(controllerContext, cancellationToken);
}

Este parece ser um tópico muito antigo, mas vale a pena compartilhar outra solução.

Você pode adicionar este método em seu arquivo global.asax, que será acionado a cada após o término da solicitação HTTP.

void Application_EndRequest(Object Sender, EventArgs e)
    {
        var request = (Sender as HttpApplication).Request;
        var response = (Sender as HttpApplication).Response;

        if (request.HttpMethod == "POST" || request.HttpMethod == "PUT")
        {


            byte[] bytes = request.BinaryRead(request.TotalBytes);
            string body = Encoding.UTF7.GetString(bytes);
            if (!String.IsNullOrEmpty(body))
            {


                // Do your logic here (Save in DB, Log in IIS etc.)
            }
        }
    }

Esse é um tópico muito antigo, mas eu gastei muito tempo (pesquise na internet) fazendo essas coisas, então irei apenas postar minha solução aqui.

Conceito

1. Substitua ExecuteAsync do método APicontroller para rastrear a solicitação de entrada, em minha solução eu crio Base_ApiController como um pai dos controladores de API do meu projeto.
2. Use System.Web.Http.Filters.ActionFilterAttribute para rastrear a resposta de saída do controlador de API
3. *** (Adicional) *** Use System.Web.Http.Filters.ExceptionFilterAttribute para registrar quando ocorrer uma exceção.

1. MyController.cs

    [APIExceptionFilter]  // use 3.
    [APIActionFilter]     // use 2.
    public class Base_APIController : ApiController
    {
        public   bool  IsLogInbound
        {
            get
            { return   ConfigurationManager.AppSettings["LogInboundRequest"] =="Y"? true:false ;     }
        }
        /// <summary>
        /// for logging exception
        /// </summary>
        /// <param name="controllerContext"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        public override Task<HttpResponseMessage> ExecuteAsync(
         HttpControllerContext controllerContext,
         CancellationToken cancellationToken
         )
        {
            // Do logging here using controllerContext.Request
            // I don't know why calling the code below make content not null Kanit P.
            var content = controllerContext.Request.Content.ReadAsStringAsync().Result.ToString(); // keep request json content
             // Do your own logging!
            if (IsLogInbound)
            {
                try
                {
                    ErrLog.Insert(ErrLog.type.InboundRequest, controllerContext.Request,
                         controllerContext.Request.RequestUri.AbsoluteUri
                         , content);
                }
                catch (Exception e) { }
            }

            // will not log err when go to wrong controller's action (error here but not go to APIExceptionFilter)
            var t = base.ExecuteAsync(controllerContext, cancellationToken);
            if (!t.Result.IsSuccessStatusCode)
            { 
            }
            return t;

        }

2. APIActionFilter.cs

    public class APIActionFilter : System.Web.Http.Filters.ActionFilterAttribute
    {
        public bool LogOutboundRequest
        {
            get
            { return ConfigurationManager.AppSettings["LogInboundRequest"] == "Y" ? true : false; }
        }

        public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
        {
            try {

                var returndata = actionExecutedContext.Response.Content.ReadAsStringAsync().Result.ToString(); 
             //keep Json response content
             // Do your own logging!
                if (LogOutboundRequest)
                {
                    ErrLog.Insert(ErrLog.type.OutboundResponse, actionExecutedContext.Response.Headers,
                       actionExecutedContext.ActionContext.ControllerContext.ControllerDescriptor.ControllerName
                      + "/"
                      + actionExecutedContext.ActionContext.ActionDescriptor.ActionName
                      , returndata );
                }
            } catch (Exception e) {

            }
     

        } 
    }
}

3. APIExceptionFilter.cs

    public class APIExceptionFilter : ExceptionFilterAttribute
    {
    public bool IsLogErr
    {
        get
        { return ConfigurationManager.AppSettings["LogExceptionRequest"] == "Y" ? true : false; }
    }


    public override void OnException(HttpActionExecutedContext context)
    {
        try
        { 
            //Do your own logging!
            if (IsLogErr)
            {
                ErrLog.Insert(ErrLog.type.APIFilterException, context.Request,
                    context.ActionContext.ControllerContext.ControllerDescriptor.ControllerName
                    + "/"
                    + context.ActionContext.ActionDescriptor.ActionName
                    , context.Exception.ToString() + context.Exception.StackTrace);
            }
        }catch(Exception e){

        }

        if (context.Exception is NotImplementedException)
        {
            context.Response = new HttpResponseMessage(HttpStatusCode.NotImplemented);
        }
        else {
            context.Response = new HttpResponseMessage(HttpStatusCode.InternalServerError);

        }
    }
}