Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

jargo

package module

Go to main page

Versions in this module

v0

v0.0.2

Mar 6, 2018

Changes in this version

+ func NormalizeNamespace(namespace string) string

+ func ResponseToFerry(res Response) ferry.Response

type Application

+ func (app *Application) NewCRUDController(resource *Resource) *Controller

+ func (app *Application) NewController(resource *Resource) *Controller

+ func (app *Application) ServeHTTP(addr string, namespace string) error

+ func (app *Application) ToFerry(namespace string) *ferry.Ferry

type FieldSet

+ func (fs *FieldSet) FieldNames() []string

+ func (fs *FieldSet) Without(names ...string) *FieldSet

+ type Options struct

+ DB *pg.DB

+ MaxPageSize int

+ PaginationStrategies *PaginationStrategies

+ Validate *validator.Validate

+ type PaginationStrategies struct

+ Cursor bool

+ Offset bool

type Realtime

+ func (r *Realtime) Bridge(mux *http.ServeMux) error

+ func (r *Realtime) Namespace() string

+ func (r *Realtime) Release()

+ func (r *Realtime) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ func (r *Realtime) SetNamespace(namespace string)

+ func (r *Realtime) Start() error

+ type Request struct

+ func (r *Request) Application() *Application

+ func (r *Request) DB() *pg.DB

+ func (r *Request) Resource() *Resource

type Resource

+ func (r *Resource) ParsePagination(app *Application, sortParams map[string]bool, pageParams map[string]string) (Pagination, error)

v0.0.1

Feb 15, 2018

Changes in this version

+ const DefaultMaxPageSize

+ const MsgAccessDenied

+ const MsgConnectionDisallowed

+ const MsgConnectionTimeout

+ const MsgInvalidResource

+ const MsgOk

+ var ErrForbidden = NewApiError(http.StatusForbidden, "FORBIDDEN", "forbidden")

+ var ErrInternalServerError = NewApiError(http.StatusInternalServerError, "INTERNAL_SERVER_ERROR", ...)

+ var ErrInvalidId = NewApiError(http.StatusBadRequest, "INVALID_ID", "invalid id parameter")

+ var ErrNotAcceptable = NewApiError(http.StatusNotAcceptable, "NOT_ACCEPTABLE", ...)

+ var ErrNotFound = NewApiError(http.StatusNotFound, "RESOURCE_NOT_FOUND", "resource not found")

+ var ErrUnsupportedMediaType = NewApiError(http.StatusUnsupportedMediaType, "UNSUPPORTED_MEDIA_TYPE", ...)

+ func ParseCreatePayload(c *Context, req *CreateRequest) (interface{}, error)

+ func ParseFieldParameters(query map[string][]string) map[string][]string

+ func ParseFilterParameters(query map[string][]string) map[string]map[string][]string

+ func ParsePageParameters(query map[string][]string) map[string]string

+ func ParseResourceId(idStr string) (int64, error)

+ func ParseSortParameters(query map[string][]string) map[string]bool

+ func ParseUpdatePayload(c *Context, req *UpdateRequest) (interface{}, error)

+ type ApiError struct

+ func ErrInvalidPayload(detail string) *ApiError

+ func ErrInvalidQueryParams(detail string) *ApiError

+ func ErrUnauthorized(detail string) *ApiError

+ func ErrValidationFailed(errors validator.ValidationErrors) *ApiError

+ func NewApiError(status int, code string, detail string) *ApiError

+ func NewErrorResponse(err error) *ApiError

+ func (e *ApiError) Error() string

+ func (e *ApiError) Payload() (string, error)

+ func (e *ApiError) Response() (int, string)

+ func (e *ApiError) Status() int

+ func (e *ApiError) ToErrorObject() *jsonapi.ErrorObject

+ type Application struct

+ func NewApplication(db *pg.DB) *Application

+ func NewApplicationWithValidate(db *pg.DB, validate *validator.Validate) *Application

+ func (app *Application) AddController(c *Controller)

+ func (app *Application) Bridge(f *ferry.Ferry, namespace string)

+ func (app *Application) BridgeRoot(f *ferry.Ferry)

+ func (app *Application) DB() *pg.DB

+ func (app *Application) MaxPageSize() int

+ func (app *Application) MustRegisterResource(model interface{}) *Resource

+ func (app *Application) RegisterResource(model interface{}) (*Resource, error)

+ func (app *Application) SetMaxPageSize(maxPageSize int)

+ func (app *Application) Validate() *validator.Validate

+ type Context struct

+ func (c *Context) Application() *Application

+ func (c *Context) DB() *pg.DB

+ func (c *Context) Resource() *Resource

+ type Controller struct

+ func NewCRUDController(resource *Resource) *Controller

+ func NewController(resource *Resource) *Controller

+ func (c *Controller) SetAction(method string, path string, handlers ...HandlerFunc)

+ func (c *Controller) SetCreateAction(handlers ...CreateHandlerFunc)

+ func (c *Controller) SetDeleteAction(handlers ...DeleteHandlerFunc)

+ func (c *Controller) SetIndexAction(handlers ...IndexHandlerFunc)

+ func (c *Controller) SetShowAction(handlers ...ShowHandlerFunc)

+ func (c *Controller) SetUpdateAction(handlers ...UpdateHandlerFunc)

+ func (c *Controller) Use(middleware ...HandlerFunc)

+ type CreateHandlerFunc func(context *Context, request *CreateRequest) Response

+ type CreateRequest struct

+ Fields *FieldSet

+ Payload io.Reader

+ func ParseCreateRequest(c *Context) (*CreateRequest, error)

+ type DeleteHandlerFunc func(context *Context, request *DeleteRequest) Response

+ type DeleteRequest struct

+ ResourceId int64

+ func ParseDeleteRequest(c *Context) (*DeleteRequest, error)

+ type FieldSet struct

+ type Filter struct

+ Eq []string

+ Gt []string

+ Gte []string

+ Like []string

+ Lt []string

+ Lte []string

+ Not []string

+ type Filters struct

+ type HandleConnectionFunc func(socket *glue.Socket, message string) bool

+ type HandlerFunc func(context *Context) Response

+ type IndexHandlerFunc func(context *Context, request *IndexRequest) Response

+ type IndexRequest struct

+ Fields *FieldSet

+ Filters *Filters

+ Pagination *Pagination

+ SortFields *SortFields

+ func ParseIndexRequest(c *Context) (*IndexRequest, error)

+ type MaySubscribeFunc func(socket *glue.Socket, resource *Resource, id int64) bool

+ type Pagination struct

+ Number int

+ Size int

+ func ParsePagination(values map[string]string, maxPageSize int) (*Pagination, error)

+ type Query struct

+ func (q *Query) Execute() (interface{}, error)

+ func (q *Query) Fields(fs *FieldSet) *Query

+ func (q *Query) Filters(f *Filters) *Query

+ func (q *Query) Pagination(p *Pagination) *Query

+ func (q *Query) Payload() (string, error)

+ func (q *Query) Response() Response

+ func (q *Query) Result() (interface{}, error)

+ func (q *Query) Sort(s *SortFields) *Query

+ func (q *Query) Status() int

+ type Realtime struct

+ ConnectionMessageTimeout time.Duration

+ HandleConnection HandleConnectionFunc

+ MaySubscribe MaySubscribeFunc

+ func NewRealtime(app *Application, namespace string) *Realtime

+ func (r *Realtime) Run() error

+ type Resource struct

+ func (r *Resource) Delete(db orm.DB) *Query

+ func (r *Resource) DeleteById(db orm.DB, id int64) *Query

+ func (r *Resource) DeleteInstance(db orm.DB, instance interface{}) *Query

+ func (r *Resource) Filters(filters map[string]*Filter) (*Filters, error)

+ func (r *Resource) IdFilter(id int64) *Filters

+ func (r *Resource) Initialize(db *pg.DB) error

+ func (r *Resource) InsertCollection(db orm.DB, instances []interface{}) *Query

+ func (r *Resource) InsertInstance(db orm.DB, instance interface{}) *Query

+ func (r *Resource) JSONAPIName() string

+ func (r *Resource) ParseFieldSet(parsed map[string][]string) (*FieldSet, error)

+ func (r *Resource) ParseFilters(parsed map[string]map[string][]string) (*Filters, error)

+ func (r *Resource) ParseJsonapiPayload(in io.Reader, validate *validator.Validate) (interface{}, error)

+ func (r *Resource) ParseJsonapiPayloadString(payload string, validate *validator.Validate) (interface{}, error)

+ func (r *Resource) ParseJsonapiUpdatePayload(in io.Reader, instance interface{}, validate *validator.Validate) (interface{}, error)

+ func (r *Resource) ParseJsonapiUpdatePayloadString(payload string, instance interface{}, validate *validator.Validate) (interface{}, error)

+ func (r *Resource) ParseSortFields(sort map[string]bool) (*SortFields, error)

+ func (r *Resource) Response(data interface{}, fieldSet *FieldSet) Response

+ func (r *Resource) ResponseAllFields(data interface{}) Response

+ func (r *Resource) ResponseWithStatusCode(data interface{}, fieldSet *FieldSet, status int) Response

+ func (r *Resource) Select(db orm.DB) *Query

+ func (r *Resource) SelectById(db orm.DB, id int64) *Query

+ func (r *Resource) SelectOne(db orm.DB) *Query

+ func (r *Resource) SortById() *SortFields

+ func (r *Resource) UpdateCollection(db orm.DB, instances []interface{}) *Query

+ func (r *Resource) UpdateInstance(db orm.DB, instance interface{}) *Query

+ func (r *Resource) Validate(validate *validator.Validate, instance interface{}) error

+ type Response interface

+ Payload func() (string, error)

+ Status func() int

+ func DefaultCreateResourceHandler(c *Context, req *CreateRequest) Response

+ func DefaultDeleteResourceHandler(c *Context, req *DeleteRequest) Response

+ func DefaultIndexResourceHandler(c *Context, req *IndexRequest) Response

+ func DefaultShowResourceHandler(c *Context, req *ShowRequest) Response

+ func DefaultUpdateResourceHandler(c *Context, req *UpdateRequest) Response

+ func NewResponse(status int, payload string) Response

+ type ShowHandlerFunc func(context *Context, request *ShowRequest) Response

+ type ShowRequest struct

+ Fields *FieldSet

+ ResourceId int64

+ func ParseShowRequest(c *Context) (*ShowRequest, error)

+ type SortFields struct

+ type UpdateHandlerFunc func(context *Context, request *UpdateRequest) Response

+ type UpdateRequest struct

+ Fields *FieldSet

+ Payload io.Reader

+ ResourceId int64

+ func ParseUpdateRequest(c *Context) (*UpdateRequest, error)