stdresp

Documentation

Index

• func Error(c http.Context, opts ...StdOpt) http.Response
• func Resp(c http.Context, code, desc string, opts ...StdOpt) http.Response
• func Success(c http.Context, opts ...StdOpt) http.Response
• type Std
• type StdOpt
  • func WithData(data any) StdOpt
  • func WithDesc(desc string) StdOpt
  • func WithErr(e error) StdOpt
  • func WithErrAccess(e error) StdOpt
  • func WithErrHeader(e error) StdOpt
  • func WithErrInvalidRule(e error) StdOpt
  • func WithErrNotFound(e error) StdOpt
  • func WithErrParameter(e error) StdOpt
  • func WithErrRuntime(e error) StdOpt
  • func WithErrThirdParty(e error) StdOpt
  • func WithErrUnsupport(e error) StdOpt
  • func WithErrWaiting(e error) StdOpt
  • func WithMaskedData(keysToMask []string, data any) StdOpt

Functions

func Error

func Error(c http.Context, opts ...StdOpt) http.Response

Error construct standard response with default error response code and description after applying any given options.

func Resp

func Resp(c http.Context, code, desc string, opts ...StdOpt) http.Response

Resp construct standard response after applying the response code and description along with any given options.

func Success

func Success(c http.Context, opts ...StdOpt) http.Response

Success construct standard response with default success response code and description after applying any given options.

Types

type Std

type Std struct {
	ResponseCode       string   `json:"responseCode"`
	ResponseDesc       string   `json:"responseDesc"`
	ResponseData       any      `json:"responseData,omitempty"`
	ResponseValidation []string `json:"responseValidation,omitempty"`
	// contains filtered or unexported fields
}

Std holds standard response structure for brispot microservice.

type StdOpt

type StdOpt func(std *Std)

StdOpt option signature that accept and modify Std response object.

func WithData

func WithData(data any) StdOpt

WithData embed given data object to the standard response as field `responseData`.

func WithDesc

func WithDesc(desc string) StdOpt

WithDesc embed given string data to the standard response as field `responseDesc`.

func WithErr

func WithErr(e error) StdOpt

WithErr embed given error to the standard response.

func WithErrAccess

func WithErrAccess(e error) StdOpt

func WithErrHeader

func WithErrHeader(e error) StdOpt

func WithErrInvalidRule

func WithErrInvalidRule(e error) StdOpt

func WithErrNotFound

func WithErrNotFound(e error) StdOpt

func WithErrParameter

func WithErrParameter(e error) StdOpt

func WithErrRuntime

func WithErrRuntime(e error) StdOpt

func WithErrThirdParty

func WithErrThirdParty(e error) StdOpt

func WithErrUnsupport

func WithErrUnsupport(e error) StdOpt

func WithErrWaiting

func WithErrWaiting(e error) StdOpt

func WithMaskedData

func WithMaskedData(keysToMask []string, data any) StdOpt

WithMaskedData masks specified keys in the response data