webapi

Documentation

Index

• Constants
• func IndexRequest(c echo.Context) error
• func ParseJSONRequest(c echo.Context, dest interface{}) error
• func Plugin() *node.Plugin
• func Server() *echo.Echo

Constants

const (
	// CfgBindAddress defines the config flag of the web API binding address.
	CfgBindAddress = "webapi.bindAddress"
	// CfgBasicAuthEnabled defines the config flag of the webapi basic auth enabler.
	CfgBasicAuthEnabled = "webapi.basic_auth.enabled"
	// CfgBasicAuthUsername defines the config flag of the webapi basic auth username.
	CfgBasicAuthUsername = "webapi.basic_auth.username"
	// CfgBasicAuthPassword defines the config flag of the webapi basic auth password.
	CfgBasicAuthPassword = "webapi.basic_auth.password"
)

const PluginName = "WebAPI"

PluginName is the name of the web API plugin.

Functions

func IndexRequest

func IndexRequest(c echo.Context) error

IndexRequest returns INDEX

func ParseJSONRequest

func ParseJSONRequest(c echo.Context, dest interface{}) error

ParseJSONRequest parses json from HTTP request body into the dest.

func Plugin

func Plugin() *node.Plugin

Plugin gets the plugin instance.

func Server

func Server() *echo.Echo

Server gets the server instance.