RA.Utilities.Core.Constants 10.0.0

RA.Utilities.Core.Constants

A centralized and consistent set of core constants for the RA Utilities ecosystem. This package helps streamline development, improve code readability, and reduce "magic strings" and "magic numbers" by providing a single source of truth for common values.

Getting started

You can install the package via the .NET CLI:

dotnet add package RA.Utilities.Core.Constants

Or through the NuGet Package Manager in Visual Studio.

✨ Available Constants

The package currently provides the following static classes:

BaseResponseCode

Contains integer constants for common HTTP status codes, aligning with standard web practices. This class was previously named HttpStatusCodes.

BaseResponseMessages

Contains default string messages for common API responses. This helps maintain a consistent tone and messaging for your API consumers.

HeaderParameters

Contains constant strings for common HTTP header names, ensuring consistency when accessing or setting headers.

ResponseType (enum)

This enum provides a standardized, machine-readable vocabulary for the outcome of an API operation. It is used within the JSON response body to give clients a specific, semantic context that is more detailed than an HTTP status code.

Example JSON Response

{
  "responseCode": 404,
  "responseType": "NotFound", // From the ResponseType enum
  "responseMessage": "Product with value '99' not found."
}

🚀 Usage Examples

Here’s how you can use these constants within an ASP.NET Core controller to create clean and consistent API endpoints.

using Microsoft.AspNetCore.Mvc;
using RA.Utilities.Core.Constants; // Import the constants

[ApiController]
[Route("api/[controller]")]
public class ProductsController : ControllerBase
{
    [HttpGet("{id}")]
    public IActionResult GetProduct(int id)
    {
        var product = _productService.GetById(id);

        if (product == null)
        {
            // Use constants for both the status code and the response message
            return NotFound(BaseResponseMessages.NotFound);
        }

        return Ok(product);
    }

    [HttpPost]
    public IActionResult CreateProduct([FromBody] Product newProduct)
    {
        if (!ModelState.IsValid)
        {
            // Use constants for a bad request
            return BadRequest(BaseResponseMessages.BadRequest);
        }

        var createdProduct = _productService.Create(newProduct);

        // Use constants for a 'Created' response
        return StatusCode(BaseResponseCode.Created, createdProduct);
    }
}

Additional documentation

For more information on how this package fits into the larger RA.Utilities ecosystem, please see the main repository documentation.

Contributing

Contributions are welcome! If you have a suggestion or find a bug, please open an issue to discuss it.

Pull Request Process

1. Fork the Repository: Start by forking the RA.Utilities repository.
2. Create a Branch: Create a new branch for your feature or bug fix from the main branch. Please use a descriptive name (e.g., feature/add-result-extensions or fix/readme-typo).
3. Make Your Changes: Write your code, ensuring it adheres to the existing coding style. Add or update XML documentation for any new public APIs.
4. Update README: If you are adding new functionality, please update the README.md file accordingly.
5. Submit a Pull Request: Push your branch to your fork and open a pull request to the main branch of the original repository. Provide a clear description of the changes you have made.

Coding Standards

• Follow the existing coding style and conventions used in the project.
• Ensure all public members are documented with clear XML comments.
• Keep changes focused. A pull request should address a single feature or bug.

Thank you for contributing!