apig

Documentation

Index

• Constants
• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetNames() []string
• func Generate(outDir, modelDir, targetFile string, all bool) int
• func Skeleton(gopath, vcs, username, project, namespace, database string) int
• type Association
• type Detail
• type Field
  • func (f *Field) IsAssociation() bool
  • func (f *Field) IsBelongsTo() bool
  • func (f *Field) PreloadAssocs() []string
• type Model
  • func (m *Model) AllPreloadAssocs() []string
• type Models
  • func (m Models) Len() int
  • func (m Models) Less(i, j int) bool
  • func (m Models) Swap(i, j int)

Constants

const (
	AssociationNone      = 0
	AssociationBelongsTo = 1
	AssociationHasMany   = 2
	AssociationHasOne    = 3
)

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func Generate

func Generate(outDir, modelDir, targetFile string, all bool) int

func Skeleton

func Skeleton(gopath, vcs, username, project, namespace, database string) int

Types

type Association

type Association struct {
	Type  int
	Model *Model
}

type Detail

type Detail struct {
	VCS       string
	User      string
	Project   string
	Namespace string
	Models    Models
	Model     *Model
	ImportDir string
	Database  string
}

type Field

type Field struct {
	Name        string
	JSONName    string
	Type        string
	Tag         string
	Association *Association
}

func (*Field) IsAssociation

func (f *Field) IsAssociation() bool

func (*Field) IsBelongsTo

func (f *Field) IsBelongsTo() bool

func (*Field) PreloadAssocs

func (f *Field) PreloadAssocs() []string

type Model

type Model struct {
	Name   string
	Fields []*Field
}

func (*Model) AllPreloadAssocs

func (m *Model) AllPreloadAssocs() []string

type Models

type Models []*Model // implements Sort interface

func (Models) Len

func (m Models) Len() int

func (Models) Less

func (m Models) Less(i, j int) bool

func (Models) Swap

func (m Models) Swap(i, j int)