responses

package
v0.0.0-...-1b39580 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 5, 2023 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package path implements HTTP responses struct features and functions

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func FromGRPCError

func FromGRPCError(err *status.Status, w http.ResponseWriter)

func InternalServerError

func InternalServerError(w http.ResponseWriter)

func NewUserResponse

func NewUserResponse(u *models.UserResponse, w http.ResponseWriter)

func NotFound

func NotFound(w http.ResponseWriter)

func Respond

func Respond(w http.ResponseWriter, statusCode int, responseBody []byte)

func RespondBadRequest

func RespondBadRequest(w http.ResponseWriter, msg string)

func RespondConflict

func RespondConflict(w http.ResponseWriter, msg string)

func RespondCreated

func RespondCreated(w http.ResponseWriter)

func RespondNotAuthorized

func RespondNotAuthorized(w http.ResponseWriter, msg string)

func RespondNotFound

func RespondNotFound(w http.ResponseWriter)

func RespondOk

func RespondOk(w http.ResponseWriter)

func User

Types

type Builder

type Builder struct {
	Response       ErrResponse
	ResponseWriter http.ResponseWriter
}

func NewErrorBuilder

func NewErrorBuilder() *Builder

func (*Builder) AddHeader

func (rb *Builder) AddHeader(key, val string) *Builder

func (*Builder) Respond

func (rb *Builder) Respond()

func (*Builder) SetError

func (rb *Builder) SetError(err error) *Builder

func (*Builder) SetMessage

func (rb *Builder) SetMessage(msg string) *Builder

func (*Builder) SetReason

func (rb *Builder) SetReason(reason string) *Builder

func (*Builder) SetResponseCode

func (rb *Builder) SetResponseCode(statusCode int) *Builder

func (*Builder) SetWriter

func (rb *Builder) SetWriter(w http.ResponseWriter) *Builder

type ErrResponse

type ErrResponse struct {
	Code    int    `json:"code"`
	Reason  string `json:"reason"`
	Headers map[string]interface{}
	Message string `json:"message,omitempty"`
	Error   string `json:"error,omitempty"`
	Data    data   `json:"data"`
	Err     error
}

type Error

type Error struct {
	Location     string `json:"location"`
	LocationType string `json:"locationType"`
	Reason       string `json:"reason"`
	Message      string `json:"message,omitempty"`
}

type ErrorResponse

type ErrorResponse struct {
	Code    int32  `json:"code"`
	Reason  string `json:"reason"`
	Message string `json:"message,omitempty"`
	Error   string `json:"error,omitempty"`
	Data    data   `json:"data"`
}

func NewAccessDeniedErrorResponse

func NewAccessDeniedErrorResponse() *ErrorResponse

func NewBadRequestErrorResponse

func NewBadRequestErrorResponse(msg string) *ErrorResponse

func NewConflictResponse

func NewConflictResponse(msg string) *ErrorResponse

func NewErrorResponse

func NewErrorResponse(statusCode int32, reason, message string) *ErrorResponse

func NewInternalServerErrorErrorResponse

func NewInternalServerErrorErrorResponse() *ErrorResponse

func NewServiceUnavailableErrorResponse

func NewServiceUnavailableErrorResponse() *ErrorResponse

func NewUnauthorizedErrorResponse

func NewUnauthorizedErrorResponse(msg string) *ErrorResponse

type NotFoundResponse

type NotFoundResponse struct {
	Code    int32  `json:"code"`
	Message string `json:"message,omitempty"`
}

swagger:model NotFoundError

func NewNotFoundResponse

func NewNotFoundResponse() *NotFoundResponse

type StatusError

type StatusError struct {
	Code int
	Err  error
}

type UnauthorizedResponse

type UnauthorizedResponse struct {
	Code    int32  `json:"code"`
	Message string `json:"message,omitempty"`
	Error   string `json:"error,omitempty"`
}

func NewUnauthorizedResponse

func NewUnauthorizedResponse() *UnauthorizedResponse

type UserResponse

type UserResponse struct {
	*models.UserResponse `json:"user"`
}

Jump to

Keyboard shortcuts

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