response

package

v0.1.38 Latest Latest Go to latest Published: Apr 30, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/deploymenttheory/go-api-http-client

Links

Open Source Insights

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 ParseContentDisposition(header string) (string, map[string]string)
func ParseContentTypeHeader(header string) (string, map[string]string)
type APIError
- func HandleAPIErrorResponse(resp *http.Response, log logger.Logger) *APIError
- func (e *APIError) Error() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func HandleAPISuccessResponse ¶ added in v0.1.14

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

HandleAPISuccessResponse reads the response body, logs the raw response details, and unmarshals the response based on the content type.

func ParseContentDisposition ¶ added in v0.1.17

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

ParseContentDisposition parses the Content-Disposition header and returns the type and any parameters.

func ParseContentTypeHeader ¶ added in v0.1.7

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

ParseContentTypeHeader parses the Content-Type header and returns the MIME type and any 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.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL