README
¶
go-function-sdk
An SDK for building OpenFaaS functions in Go
Installing
Use go get to retrieve the SDK to add it to your GOPATH workspace, or
project's Go module dependencies.
go get github.com/openfaas-incubator/go-function-sdk
To update the SDK use go get -u to retrieve the latest version of the SDK.
go get -u github.com/openfaas-incubator/go-function-sdk
Features
Handler definition
type FunctionHandler interface {
Handle(req Request) (Response, error)
}
FunctionHandler interface is used by golang-http
template to define a functions handler
Secrets
For the time being please use the secrets function from github.com/openfaas/openfaas-cloud/sdk
See: https://github.com/openfaas/openfaas-cloud/blob/master/sdk/secrets.go
Usage:
secret, err := sdk.ReadSecret("MY_SECRET")
if err != nil {
return fmt.Errorf("error reading secret. %v", err)
}
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FunctionHandler ¶
FunctionHandler used for a serverless Go method invocation
type Request ¶
type Request struct {
Body []byte
Header http.Header
QueryString string
Method string
Host string
// contains filtered or unexported fields
}
Request of function call
func (*Request) WithContext ¶
WithContext overides the context for the Request struct
type Response ¶
type Response struct {
// Body the body will be written back
Body []byte
// StatusCode needs to be populated with value such as http.StatusOK
StatusCode int
// Header is optional and contains any additional headers the function response should set
Header http.Header
}
Response of function call
Source Files
Click to show internal directories.
Click to hide internal directories.