jsonapisdk

package module

Go to main page

Versions in this module

v0

v0.5.4

Jun 15, 2018

v0.5.2

Jun 15, 2018

Changes in this version

type Endpoint

+ func (e *Endpoint) String() string

type EndpointType

+ const DeleteAll

+ const PatchAll

+ func (e EndpointType) String() string

type JSONAPIHandler

+ func (h *JSONAPIHandler) EndpointForbidden(model *ModelHandler, endpoint EndpointType) http.HandlerFunc

v0.5.1

Jun 15, 2018

Changes in this version

+ var CreateRead = []EndpointType

+ var CreateReadUpdate = []EndpointType

+ var DefaultErrorMap map[unidb.Error]jsonapi.ErrorObject = map[unidb.Error]jsonapi.ErrorObject

+ var FullCRUD = []EndpointType

+ var IErrInvalidModelEndpoint = errors.New("Invalid model endpoint")

+ var IErrInvalidScopeType = errors.New(...)

+ var IErrInvalidValueType = errors.New("Trying to preset values of invalid type.")

+ var IErrModelHandlerNotFound = errors.New("Model Handler not found.")

+ var IErrPresetInvalidScope = errors.New("Pressetting invalid scope value.")

+ var IErrPresetNoValues = errors.New("Preset no values")

+ var IErrScopeNoValue = errors.New("No value provided within scope.")

+ var IErrValueNotValid = errors.New("Value not valid.")

+ var ReadOnly = []EndpointType

+ func SetContentType(rw http.ResponseWriter)

+ type Endpoint struct

+ Prechecks []*jsonapi.PresetPair

+ PresetFilters []*jsonapi.FilterField

+ PresetPaginate *jsonapi.Pagination

+ PresetSort []*jsonapi.SortField

+ Presets []*jsonapi.PresetPair

+ Type EndpointType

+ type EndpointType int

+ const Create

+ const Delete

+ const Get

+ const List

+ const Patch

+ const UnkownPath

+ type ErrorManager struct

+ func NewDBErrorMgr() *ErrorManager

+ func (r *ErrorManager) Handle(dberr *unidb.Error) (*jsonapi.ErrorObject, error)

+ func (r *ErrorManager) LoadCustomErrorMap(errorMap map[unidb.Error]jsonapi.ErrorObject)

+ func (r *ErrorManager) UpdateErrorEntry(dberr unidb.Error, apierr jsonapi.ErrorObject)

+ type JSONAPIHandler struct

+ Controller *jsonapi.Controller

+ DBErrMgr *ErrorManager

+ DefaultRepository Repository

+ LanguageMatcher language.Matcher

+ ModelHandlers map[reflect.Type]*ModelHandler

+ SupportedLanguages []language.Tag

+ Validator *validator.Validate

+ func NewHandler(c *jsonapi.Controller, log unilogger.LeveledLogger, DBErrMgr *ErrorManager) *JSONAPIHandler

+ func (h *JSONAPIHandler) AddModelHandlers(models ...*ModelHandler) error

+ func (h *JSONAPIHandler) AddModelsEndpoint(model interface{}, endpoint *Endpoint) error

+ func (h *JSONAPIHandler) AddModelsPrecheckPair(model interface{}, precheckPair *jsonapi.PresetPair, endpoint EndpointType) error

+ func (h *JSONAPIHandler) AddModelsPresetPair(model interface{}, presetPair *jsonapi.PresetPair, endpoint EndpointType) error

+ func (h *JSONAPIHandler) CheckPrecheckValues(scope *jsonapi.Scope, filter *jsonapi.FilterField) (err error)

+ func (h *JSONAPIHandler) CheckValueLanguage(scope *jsonapi.Scope, rw http.ResponseWriter) (langtag language.Tag, ok bool)

+ func (h *JSONAPIHandler) Create(model *ModelHandler) http.HandlerFunc

+ func (h *JSONAPIHandler) Delete(model *ModelHandler) http.HandlerFunc

+ func (h *JSONAPIHandler) DisplaySupportedLanguages() []string

+ func (h *JSONAPIHandler) Get(model *ModelHandler) http.HandlerFunc

+ func (h *JSONAPIHandler) GetIncluded(scope *jsonapi.Scope, rw http.ResponseWriter, req *http.Request, ...) (correct bool)

+ func (h *JSONAPIHandler) GetLanguage(req *http.Request, rw http.ResponseWriter) (tag language.Tag, ok bool)

+ func (h *JSONAPIHandler) GetModelHandler(model interface{}) (mHandler *ModelHandler, err error)

+ func (h *JSONAPIHandler) GetPresetValues(presetScope *jsonapi.Scope, filter *jsonapi.FilterField, ...) (values []interface{}, ok bool)

+ func (h *JSONAPIHandler) GetRelated(root *ModelHandler) http.HandlerFunc

+ func (h *JSONAPIHandler) GetRelationship(root *ModelHandler) http.HandlerFunc

+ func (h *JSONAPIHandler) GetRepositoryByType(model reflect.Type) (repo Repository)

+ func (h *JSONAPIHandler) HandleValidateError(model *ModelHandler, err error, rw http.ResponseWriter)

+ func (h *JSONAPIHandler) HeaderContentLanguage(rw http.ResponseWriter, langtag language.Tag)

+ func (h *JSONAPIHandler) List(model *ModelHandler) http.HandlerFunc

+ func (h *JSONAPIHandler) MarshalErrors(rw http.ResponseWriter, errors ...*jsonapi.ErrorObject)

+ func (h *JSONAPIHandler) MarshalInternalError(rw http.ResponseWriter)

+ func (h *JSONAPIHandler) MarshalScope(scope *jsonapi.Scope, rw http.ResponseWriter, req *http.Request)

+ func (h *JSONAPIHandler) Patch(model *ModelHandler) http.HandlerFunc

+ func (h *JSONAPIHandler) PresetScopeValue(scope *jsonapi.Scope, fieldFilter *jsonapi.FilterField, values ...interface{}) (err error)

+ func (h *JSONAPIHandler) ReplaceModelsEndpoint(model interface{}, endpoint *Endpoint) error

+ func (h *JSONAPIHandler) SetDefaultRepo(Repositoriesitory Repository)

+ func (h *JSONAPIHandler) SetLanguages(languages ...language.Tag)

+ func (h *JSONAPIHandler) SetPresetFilterValues(filter *jsonapi.FilterField, values ...interface{}) error

+ func (h *JSONAPIHandler) UnmarshalScope(model reflect.Type, rw http.ResponseWriter, req *http.Request) *jsonapi.Scope

+ type ModelHandler struct

+ Create *Endpoint

+ Delete *Endpoint

+ Get *Endpoint

+ List *Endpoint

+ ModelType reflect.Type

+ Patch *Endpoint

+ Repository Repository

+ func NewModelHandler(model interface{}, repository Repository, endpoints []EndpointType) (m *ModelHandler, err error)

+ func (m *ModelHandler) AddEndpoint(endpoint *Endpoint) error

+ func (m *ModelHandler) AddOffsetPresetPaginate(limit, offset int, endpointTypes []EndpointType) error

+ func (m *ModelHandler) AddPrecheckPair(precheckPair *jsonapi.PresetPair, endpoint EndpointType) error

+ func (m *ModelHandler) AddPresetFilter(fieldName string, endpointTypes []EndpointType, ...) error

+ func (m *ModelHandler) AddPresetPair(presetPair *jsonapi.PresetPair, endpoint EndpointType) error

+ func (m *ModelHandler) AddPresetSort(fieldName string, endpointTypes []EndpointType, order jsonapi.Order) error

+ func (m *ModelHandler) ReplaceEndpoint(endpoint *Endpoint) error

+ type Repository interface

+ Create func(scope *jsonapi.Scope) *unidb.Error

+ Delete func(scope *jsonapi.Scope) *unidb.Error

+ Get func(scope *jsonapi.Scope) *unidb.Error

+ List func(scope *jsonapi.Scope) *unidb.Error

+ Patch func(scope *jsonapi.Scope) *unidb.Error

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