kipapi

package module

v0.2.0 Latest Latest Go to latest Published: Dec 5, 2017 License: MIT Imports: 8 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/fulldump/kipapi

Links

Open Source Insights

README ¶

^{Tested Go versions 1.5, 1.6, 1.7, 1.8, 1.9}

Kipapi is a CRUD HTTP API.

How to use
- Create and expose CRUD via HTTP API
Kipapi developer
- Run tests
- Coverage

How to use

Create and expose CRUD via HTTP API

mydao := NewDaoUsers()  // Build DAO with Kip
myapi := golax.NewApi() // Create golax api
kipapi.New(myapi.Root, mydao) // Expose

Kipapi developer

Run tests

make setup && make test

Coverage

make setup && make coverage

Documentation ¶

Index ¶

func DefaultEncode(i interface{}, c *golax.Context)
func GetItem(c *golax.Context) *kip.Item
type Context
type Kipapi
- func New(pn *golax.Node, d *kip.Dao) *Kipapi
- func (k *Kipapi) Map(i *kip.Item, c *golax.Context) bson.M
- func (k *Kipapi) PrintItem(i *kip.Item, c *golax.Context)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DefaultEncode ¶ added in v0.2.0

func DefaultEncode(i interface{}, c *golax.Context)

func GetItem ¶

func GetItem(c *golax.Context) *kip.Item

Types ¶

type Context ¶

type Context struct {
	Filter      bson.M
	Item        *kip.Item
	Printed     map[string]interface{}
	PrintedList []interface{}
	Patches     []*kip.Patch
	Patch       *kip.Patch
}

type Kipapi ¶

type Kipapi struct {
	Dao            *kip.Dao
	ParentNode     *golax.Node
	CollectionNode *golax.Node
	ItemNode       *golax.Node
	Encode         func(i interface{}, c *golax.Context)

	HookCreate    func(d *Context, c *golax.Context)
	HookDelete    func(d *Context, c *golax.Context)
	HookFilter    func(d *Context, c *golax.Context)
	HookInsert    func(d *Context, c *golax.Context)
	HookList      func(d *Context, c *golax.Context)
	HookListItem  func(d *Context, c *golax.Context) *kip.Item
	HookPrint     func(d *Context, c *golax.Context)
	HookPrintList func(d *Context, c *golax.Context) interface{}
	HookPatch     func(d *Context, c *golax.Context)
	HookPatchItem func(d *Context, c *golax.Context)
	HookRetrieve  func(d *Context, c *golax.Context)
	HookUpdate    func(d *Context, c *golax.Context)
	HookId        func(d *Context, c *golax.Context)
}

func New ¶

func New(pn *golax.Node, d *kip.Dao) *Kipapi

func (*Kipapi) Map ¶

func (k *Kipapi) Map(i *kip.Item, c *golax.Context) bson.M

func (*Kipapi) PrintItem ¶

func (k *Kipapi) PrintItem(i *kip.Item, c *golax.Context)

Source Files ¶

View all Source files

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