api

package

v0.0.0-...-66b7006 Latest Latest Go to latest Published: Jan 2, 2024 License: MIT Imports: 9 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/bryanmorgan/time-tracking-api

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func BadInputs(w http.ResponseWriter, message string, code string, field string)
func CloseBody(body io.ReadCloser)
func ErrorJson(w http.ResponseWriter, e *Error, httpStatusCode int)
func Json(w http.ResponseWriter, r *http.Request, data interface{})
func JsonWithStatus(w http.ResponseWriter, r *http.Request, data interface{}, statusCode int)
func TimeJson(t time.Time) string
func WarnJson(w http.ResponseWriter, e *Error, httpStatusCode int)
type Error
- func NewError(errorDetail interface{}, message string, code string, details ...ErrorDetail) *Error
- func NewFieldError(errorDetail interface{}, message string, code string, field string) *Error
type ErrorDetail
- func NewErrorDetail(key string, value interface{}) ErrorDetail

Constants ¶

View Source

const (
	PANIC            = "Panic"
	NotFound         = "NotFound"
	MethodNotAllowed = "MethodNotAllowed"

	InvalidJson      = "InvalidJson"
	JsonEncodeFailed = "JsonEncodeFailed"
	SystemError      = "SystemError"

	EncryptionFailed    = "EncryptionFailed"
	TokenCreationFailed = "TokenCreationFailed"

	AccountExists        = "AccountExists"
	UpdateFailed         = "UpdateFailed"
	AccountCreateFailed  = "AccountCreateFailed"
	ProfileCreateFailed  = "ProfileCreateFailed"
	EmailExistsInAccount = "EmailExistsInAccount"
	ProfileNotFound      = "ProfileNotFound"
	InvalidEmail         = "InvalidEmail"
	InvalidForgotToken   = "InvalidForgotToken"
	InvalidPassword      = "InvalidPassword"
	PasswordMismatch     = "PasswordMismatch"
	InvalidField         = "InvalidField"
	ProfileLocked        = "ProfileLocked"
	NotAuthorized        = "NotAuthorized"

	IncorrectPassword = "IncorrectPassword"
	InvalidToken      = "InvalidToken"
	TokenExpired      = "TokenExpired"
	MissingToken      = "MissingToken"

	ProfileInactive = "ProfileInactive"
	AccountInactive = "AccountInactive"

	MissingField = "MissingField"
	FieldSize    = "FieldSize"

	InvalidWeekStart = "InvalidWeekStart"
	InvalidRole      = "InvalidRole"
	InvalidTimezone  = "InvalidTimezone"

	InvalidClient  = "InvalidClient"
	InvalidTask    = "InvalidTask"
	InvalidProject = "InvalidProject"
)

Error Codes

View Source

const (
	SuccessStatus = "success"
	ErrorStatus   = "error"
)

Variables ¶

This section is empty.

Functions ¶

func BadInputs ¶

func BadInputs(w http.ResponseWriter, message string, code string, field string)

func CloseBody ¶

func CloseBody(body io.ReadCloser)

func ErrorJson ¶

func ErrorJson(w http.ResponseWriter, e *Error, httpStatusCode int)

Writes an error JSON response

func Json ¶

func Json(w http.ResponseWriter, r *http.Request, data interface{})

Writes a successful JSON response and marshals the value type as the data element

func JsonWithStatus ¶

func JsonWithStatus(w http.ResponseWriter, r *http.Request, data interface{}, statusCode int)

Writes a JSON response with the given header status code and marshals the value type as the data element

func TimeJson ¶

func TimeJson(t time.Time) string

Standard Time JSON format

func WarnJson ¶

func WarnJson(w http.ResponseWriter, e *Error, httpStatusCode int)

Writes an error JSON response

Types ¶

type Error ¶

type Error struct {
	Err     error
	Message string
	Code    string
	Detail  map[string]interface{}
}

func NewError ¶

func NewError(errorDetail interface{}, message string, code string, details ...ErrorDetail) *Error

Standardize the creation and reporting of errors using a generic Err type

func NewFieldError ¶

func NewFieldError(errorDetail interface{}, message string, code string, field string) *Error

func (*Error) Error ¶

func (e *Error) Error() string

func (*Error) MarshalJSON ¶

func (e *Error) MarshalJSON() ([]byte, error)

func (*Error) String ¶

func (e *Error) String() string

type ErrorDetail ¶

type ErrorDetail struct {
	Key   string
	Value interface{}
}

func NewErrorDetail ¶

func NewErrorDetail(key string, value interface{}) ErrorDetail

Source Files ¶

View all Source files

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