Documentation
¶
Index ¶
- type Detail
- type ErrorMessage
- type ErrorObject
- func (e *ErrorObject) BuildErrorMessage(idiom, messageKey string, replacements []string) *ErrorObject
- func (e *ErrorObject) BuildMessage(idiom string, errorMessage *ErrorMessage) *ErrorObject
- func (e *ErrorObject) CreateErrorResponse(w http.ResponseWriter, err error, statusCode int)
- func (e *ErrorObject) CreateErrorResponseV2(w http.ResponseWriter)
- func (e *ErrorObject) GetError() string
- func (e *ErrorObject) GetErrorMessage() *ErrorMessage
- func (e *ErrorObject) GetStatusCode() int
- func (e *ErrorObject) SetError(err error, statusCode int) *ErrorObject
- type ErrorResponse
- type Lang
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ErrorMessage ¶ added in v1.0.30
ErrorMessage estrutur responsavel por armazenar informacoes de erro que serao enviadas ao usuario
func BuildErrorMessage ¶ added in v1.0.30
func BuildErrorMessage(err error, statusCode int, messageKey string, replacements []string) *ErrorMessage
BuildErrorMessage constroi um objeto ErrorMessage de forma completa
func NewErrorMessage ¶ added in v1.0.30
func NewErrorMessage(defaultStatusCode int) *ErrorMessage
NewErrorMessage instancia um novo objeto ErrorMessage setando o statusCode utilizado na resposta do servidor
func (*ErrorMessage) IsEmpty ¶ added in v1.0.30
func (e *ErrorMessage) IsEmpty() bool
IsEmpty valida se ErrorMessage é vazio
type ErrorObject ¶
type ErrorObject struct {
ErrorMessage *ErrorMessage
Lang Lang
}
ErrorObject abstração responsável por armazenar as informações de erro
func LoadLanguages ¶
func LoadLanguages(messages map[string]map[string]string, context string) ErrorObject
LoadLanguages função principal necessária para carregar as mensagens de erro que serão utilizadas
func (*ErrorObject) BuildErrorMessage ¶
func (e *ErrorObject) BuildErrorMessage(idiom, messageKey string, replacements []string) *ErrorObject
BuildErrorMessage responsável por atribuir os valores que serão usados para criar uma mensagem de erro internacionalizada
func (*ErrorObject) BuildMessage ¶ added in v1.0.30
func (e *ErrorObject) BuildMessage(idiom string, errorMessage *ErrorMessage) *ErrorObject
BuildMessage constroi o objeto ErrorObject utilizado pela aplicacao para montar a estrutura padrao de resposta
func (*ErrorObject) CreateErrorResponse ¶
func (e *ErrorObject) CreateErrorResponse(w http.ResponseWriter, err error, statusCode int)
CreateErrorResponse constrói a estrutura padrão de mensagem de erro e escreve a resposta no response
func (*ErrorObject) CreateErrorResponseV2 ¶ added in v1.0.30
func (e *ErrorObject) CreateErrorResponseV2(w http.ResponseWriter)
CreateErrorResponseV2 constrói a estrutura padrão de mensagem de erro utilizando os valores setados anteriormente e escreve a resposta no response Necessário o objeto ErrorMessage exista e tenha sido construido utilizando o metodo ErrorObject.BuildMessage
func (*ErrorObject) GetError ¶ added in v1.0.30
func (e *ErrorObject) GetError() string
GetError retorna a mensagem de erro no nível de desenvolvimento, ou seja a info de forma técnica
func (*ErrorObject) GetErrorMessage ¶
func (e *ErrorObject) GetErrorMessage() *ErrorMessage
GetErrorMessage retorna uma instancia de ErrorMessage caso nao exista
func (*ErrorObject) GetStatusCode ¶ added in v1.0.30
func (e *ErrorObject) GetStatusCode() int
GetStatusCode retorna o statuscode caso nao exista retorna status 500
func (*ErrorObject) SetError ¶
func (e *ErrorObject) SetError(err error, statusCode int) *ErrorObject
SetError função genérica para ser utilizada caso NÃO seja necessária mensagem customizada traduzida
type ErrorResponse ¶
type ErrorResponse struct {
Error Detail `json:"error"`
}
ErrorResponse estrutura padrao de respoosta de erro em APIS
func (*ErrorResponse) BuildDetail ¶ added in v1.0.30
func (e *ErrorResponse) BuildDetail(message, messageForUser string)
BuildDetail constroi o objeto Detail