rest

Documentation

Index

• func EncodeAndWriteResponse(i any, w *echo.Response, lc log.Logger) error
• func WriteDefaultHttpHeader(w http.ResponseWriter, ctx context.Context, statusCode int)
• func WriteErrorResponse(w *echo.Response, ctx context.Context, lc log.Logger, err errors.Error, ...) error
• func WriteHttpContentTypeHeader(w http.ResponseWriter, ctx context.Context, statusCode int, contentType string)
• type BaseResponse
  • func NewBaseResponse(requestId string, message string, statusCode int) BaseResponse
• type HTTPSender
  • func NewHTTPSender(url string, mimeType string) HTTPSender
• type Versionable
  • func NewVersionable() Versionable

Functions

func EncodeAndWriteResponse

func EncodeAndWriteResponse(i any, w *echo.Response, lc log.Logger) error

func WriteDefaultHttpHeader

func WriteDefaultHttpHeader(w http.ResponseWriter, ctx context.Context, statusCode int)

func WriteErrorResponse

func WriteErrorResponse(w *echo.Response, ctx context.Context, lc log.Logger, err errors.Error, requestId string) error

WriteErrorResponse writes Http header, encode error response with JSON format and writes to the HTTP response.

func WriteHttpContentTypeHeader

func WriteHttpContentTypeHeader(w http.ResponseWriter, ctx context.Context, statusCode int, contentType string)

Types

type BaseResponse

type BaseResponse struct {
	Versionable `json:",inline"`
	RequestId   string `json:"requestId,omitempty"`
	Message     string `json:"message,omitempty"`
	StatusCode  int    `json:"statusCode"`
}

BaseResponse defines the base content for response DTOs (data transfer objects).

func NewBaseResponse

func NewBaseResponse(requestId string, message string, statusCode int) BaseResponse

type HTTPSender

type HTTPSender interface {
	// SetHTTPRequestHeaders sets up http request headers
	SetHTTPRequestHeaders(httpRequestHeaders map[string]string)

	// SetSecretData sets up http secret header
	SetSecretData(name, valueKey, headerName, valuePrefix string)

	// HTTPPost sends http POST request with data
	HTTPPost(dic *di.Container, data any) errors.Error
}

HTTPSender is the interface for http requests

func NewHTTPSender

func NewHTTPSender(url string, mimeType string) HTTPSender

NewHTTPSender creates, initializes and returns a new instance of HTTPSender

type Versionable

type Versionable struct {
	ApiVersion string `json:"apiVersion" validate:"required"`
}

Versionable shows the API version in DTOs

func NewVersionable

func NewVersionable() Versionable