response

Documentation

Overview

response/error.go This package provides utility functions and structures for handling and categorizing HTTP error responses.

response/parse.go

response/success.go

Responsible for handling successful API responses. It reads the response body, logs the raw response details,

and unmarshals the response based on the content type (JSON or XML).

Index

• func HandleAPISuccessResponse(resp *http.Response, out interface{}, log logger.Logger) error
• func ParseContentTypeHeader(header string) (string, map[string]string)
• type APIError
  • func HandleAPIErrorResponse(resp *http.Response, log logger.Logger) *APIError
  • func (e *APIError) Error() string

Functions

func HandleAPISuccessResponse

func HandleAPISuccessResponse(resp *http.Response, out interface{}, log logger.Logger) error

HandleAPISuccessResponse handles the HTTP success response from an API and unmarshals the response body into the provided output struct.

func ParseContentTypeHeader

func ParseContentTypeHeader(header string) (string, map[string]string)

ParseContentTypeHeader parses the Content-Type header and extracts the MIME type and parameters.

Types

type APIError

type APIError struct {
	StatusCode  int      `json:"status_code"`       // HTTP status code
	Method      string   `json:"method"`            // HTTP method used for the request
	URL         string   `json:"url"`               // The URL of the HTTP request
	Message     string   `json:"message"`           // Summary of the error
	Details     []string `json:"details,omitempty"` // Detailed error messages, if any
	RawResponse string   `json:"raw_response"`      // Raw response body for debugging
}

APIError represents an api error response.

func HandleAPIErrorResponse

func HandleAPIErrorResponse(resp *http.Response, log logger.Logger) *APIError

HandleAPIErrorResponse handles the HTTP error response from an API and logs the error.

func (*APIError) Error

func (e *APIError) Error() string

Error returns a string representation of the APIError, making it compatible with the error interface.