ApiResponses 1.0.0

ApiResponses

Description

Tool for sending responses to API queries for ASP.NET

Installation

PM> Install-Package ApiResponses

> dotnet add package ApiResponses

Available methods

    ActionResult Good(HttpContext context, IList data);
    ActionResult Good(HttpContext context, string data);
    
    ActionResult BadRequest(HttpContext context, IList data);
    ActionResult BadRequest(HttpContext context, string data);
    
    ActionResult Forbidden(HttpContext context, string data);
    
    ActionResult Unauthorized(HttpContext context);
    
    ActionResult EndpointNotFound(HttpContext context);
    
    ActionResult ServerProblem(HttpContext context, string data);
    
    ActionResult Custom(HttpContext context, int statusCode, string statusName, string message, string data);
    ActionResult Custom(HttpContext context, int statusCode, string statusName, string message, IList data);
    ActionResult Custom(HttpContext context, int statusCode, string statusName, string message);

Usage

using ApiResponses;
...

[ApiController]
[Route("api/[controller]")]
public class AuthController : ControllerBase
{
    [HttpPost]
    public IActionResult Login([FromBody] LoginModel user)
    {
        // code
        return ApiResponse.Good(this.HttpContext, "Successfully logged in");
    }
}

Response

{
    "statusName": "Ok",
    "statusCode": 200,
    "statusDescription": "OK",
    "message": "Everything is good",
    "dateTime": "2022-01-18T16:29:18.9383181+01:00",
    "data": [
        "Successfully logged in"
    ]
}

TODO:

More methods need to be added corresponding to HTTP codes - currently there are only the most basic methods and general Custom methods