api

Documentation

Index

• type APIError
  • func BadRequestError(message string) *APIError
  • func InternalServerError(message string) *APIError
  • func NewAPIError(statusCode int, errorCode, message string) *APIError
  • func NotFoundError(message string) *APIError
  • func UnauthorizedError(message string) *APIError
  • func (e *APIError) Error() string
• type Response
  • func NewErrorResponse(message string) Response
  • func NewSuccessResponse(data interface{}) Response

Types

type APIError

type APIError struct {
	StatusCode int    // HTTP status code
	ErrorCode  string // Custom error code
	Message    string // Error message
}

APIError is a structure for storing API error information

func BadRequestError

func BadRequestError(message string) *APIError

BadRequestError creates an APIError instance representing a BadRequest

func InternalServerError

func InternalServerError(message string) *APIError

InternalServerError creates an APIError instance representing an InternalServer error

func NewAPIError

func NewAPIError(statusCode int, errorCode, message string) *APIError

NewAPIError creates an instance of APIError

func NotFoundError

func NotFoundError(message string) *APIError

NotFoundError creates an APIError instance representing a NotFound

func UnauthorizedError

func UnauthorizedError(message string) *APIError

UnauthorizedError creates an APIError instance representing an Unauthorized

func (*APIError) Error

func (e *APIError) Error() string

Error method implements the error interface

type Response

type Response struct {
	Success bool        `json:"success"`
	Message string      `json:"message"`
	Data    interface{} `json:"data,omitempty"`
}

Response is a basic structure for API response

func NewErrorResponse

func NewErrorResponse(message string) Response

Create an error response

func NewSuccessResponse

func NewSuccessResponse(data interface{}) Response

Create a successful response