prism

package module

v0.0.0-...-3d294e8 Latest Latest Go to latest Published: Apr 5, 2019 License: MIT Imports: 15 Imported by: 4

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

Status: development

Package prism implements a reflection based rest api builder using its subpackages.

This section is empty.

This section is empty.

This section is empty.

type BinaryTransfer struct {
	// contains filtered or unexported fields
}

func (bt *BinaryTransfer) Download(name string, input io.ReadSeeker, finally func(), validFor time.Duration) string

func (bt *BinaryTransfer) DownloadFile(path string, validFor time.Duration) (string, error)

type Builder struct {
	// contains filtered or unexported fields
}

func New() Builder

func (b Builder) API(label string, apiFunc func(a *api.API, bt *BinaryTransfer)) Builder

func (b Builder) AuthConfig(config apiauth.Config) Builder

func (b Builder) AuthDB(authDB *bbolt.DB) Builder

func (b Builder) Build() (*Prism, error)

func (b Builder) Description(description string) Builder

func (b Builder) Host(host string) Builder

func (b Builder) Schemes(schemes ...string) Builder

func (b Builder) Title(title string) Builder

type Prism struct {
	User    *apiauth.Authorizer
	Admin   *apiauth.Authorizer
	Handler http.Handler
}

Path	Synopsis
_examples
download
hello
api Package api implements reflection based http.Handler generation.	Package api implements reflection based http.Handler generation.
apiauth Package apiauth provides persistent authorization based on boltdb.	Package apiauth provides persistent authorization based on boltdb.
apidoc Package apidoc implements reflection based api documentation using the OpenAPI 2.0 specification (Swagger).	Package apidoc implements reflection based api documentation using the OpenAPI 2.0 specification (Swagger).
swaggerui Package swaggerui provides a http.Handler to serve apidoc.Documentation with swagger-ui (v3.19.4).	Package swaggerui provides a http.Handler to serve apidoc.Documentation with swagger-ui (v3.19.4).
assets