handlers

README

handlers

Common HTTP handler utilities for Gin.

Usage

import "github.com/adeptry-app/go-common/handlers"

// Error responses
handlers.RespondError(c, http.StatusBadRequest, "Invalid input")
handlers.LogAndRespondError(c, http.StatusInternalServerError, err, "Operation failed")
handlers.HandleRepositoryError(c, err, "Resource not found", "Database error")

// Location header for created resources
handlers.SetLocationHeader(c, resourceID) // Sets Location: /current/path/{id}

Documentation

Overview

Package handlers provides common HTTP handler utilities.

Index

• func HandleRepositoryError(c *gin.Context, err error, notFoundMsg, internalMsg string)
• func LogAndRespondError(c *gin.Context, statusCode int, err error, userMsg string)
• func RespondError(c *gin.Context, statusCode int, userMsg string)
• func SetLocationHeader(c *gin.Context, id int64)

Functions

func HandleRepositoryError

func HandleRepositoryError(c *gin.Context, err error, notFoundMsg, internalMsg string)

HandleRepositoryError checks if the error is a record not found error and responds with appropriate HTTP status code (404 or 500). For internal errors, it logs the error with structured logging.

func LogAndRespondError

func LogAndRespondError(c *gin.Context, statusCode int, err error, userMsg string)

LogAndRespondError logs the error with context and responds with the given status code. Use this for non-repository errors (auth failures, validation errors, external service errors).

func RespondError

func RespondError(c *gin.Context, statusCode int, userMsg string)

RespondError responds with an error without logging (for expected errors like validation failures). Use this when the error is not exceptional and doesn't need logging (e.g., invalid input). Sole producer of the error envelope every service returns.

func SetLocationHeader

func SetLocationHeader(c *gin.Context, id int64)

SetLocationHeader sets the Location header for created resources. Follows REST convention of providing URI to newly created resource.