Documentation
¶
Overview ¶
Package proxyrequest is an Ambient plugin with middleware that proxies requests.
Index ¶
- type Plugin
- func (p *Plugin) Enable(toolkit *ambient.Toolkit) error
- func (p *Plugin) GrantRequests() []ambient.GrantRequest
- func (p *Plugin) Middleware() []func(next http.Handler) http.Handler
- func (p *Plugin) PluginName() string
- func (p *Plugin) PluginVersion() string
- func (p *Plugin) ProxyRequest(next http.Handler) http.Handler
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Plugin ¶
type Plugin struct {
*ambient.PluginBase
// contains filtered or unexported fields
}
Plugin represents an Ambient plugin.
func New ¶
New returns an Ambient plugin with middleware that proxies requests.
Example ¶
package main
import (
"log"
"net/url"
"github.com/ambientkit/ambient"
"github.com/ambientkit/ambient/pkg/ambientapp"
"github.com/ambientkit/plugin/logger/zaplogger"
"github.com/ambientkit/plugin/middleware/proxyrequest"
"github.com/ambientkit/plugin/storage/memorystorage"
)
func main() {
URL, err := url.Parse("http://localhost:8080")
if err != nil {
log.Fatalln(err.Error())
}
plugins := &ambient.PluginLoader{
// Core plugins are implicitly trusted.
Router: nil,
TemplateEngine: nil,
SessionManager: nil,
// Trusted plugins are those that are typically needed to boot so they
// will be enabled and given full access.
TrustedPlugins: map[string]bool{},
Plugins: []ambient.Plugin{},
Middleware: []ambient.MiddlewarePlugin{
// Middleware - executes top to bottom.
proxyrequest.New(URL, "/api"),
},
}
_, _, err = ambientapp.NewApp("myapp", "1.0",
zaplogger.New(),
ambient.StoragePluginGroup{
Storage: memorystorage.New(),
},
plugins)
if err != nil {
log.Fatalln(err.Error())
}
}
func (*Plugin) GrantRequests ¶
func (p *Plugin) GrantRequests() []ambient.GrantRequest
GrantRequests returns a list of grants requested by the plugin.
func (*Plugin) Middleware ¶
Middleware returns router middleware.
func (*Plugin) PluginName ¶
PluginName returns the plugin name.
func (*Plugin) PluginVersion ¶
PluginVersion returns the plugin version.
Click to show internal directories.
Click to hide internal directories.