rest

package

v0.0.0-...-9869d36 Latest Latest Go to latest Published: Apr 25, 2023 License: MIT Imports: 14 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/wazofski/gostorz

Links

Open Source Insights

README ¶

REST Server

REST API Server that exposes Store functionality

Usage

srv := rest.Server(generated.Schema(), store_to_expose,
    rest.TypeMethods(generated.WorldKind(),
        rest.ActionGet, rest.ActionCreate,
        rest.ActionDelete, rest.ActionUpdate),
    rest.TypeMethods("AnotherWorld", rest.ActionGet))
)

// use cancel function to stop server
cancel = srv.Listen(port) // does not block

Documentation ¶

Index ¶

Constants
func Server(schema store.SchemaHolder, stor store.Store, exposed ..._TypeMethods) store.Endpoint
func TypeMethods(kind string, actions ...Action) _TypeMethods
type Action

Constants ¶

View Source

const (
	PropFilterArg  = "pf"
	KeyFilterArg   = "kf"
	IncrementalArg = "inc"
	PageSizeArg    = "pageSize"
	PageOffsetArg  = "pageOffset"
	OrderByArg     = "orderBy"
)

Variables ¶

This section is empty.

Functions ¶

func Server ¶

func Server(schema store.SchemaHolder, stor store.Store, exposed ..._TypeMethods) store.Endpoint

func TypeMethods ¶

func TypeMethods(kind string, actions ...Action) _TypeMethods

Types ¶

type Action ¶

type Action string

const (
	ActionCreate Action = http.MethodPost
	ActionUpdate Action = http.MethodPut
	ActionDelete Action = http.MethodDelete
	ActionGet    Action = http.MethodGet
)

Source Files ¶

View all Source files

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