webapi

Documentation

Index

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

Constants

const PluginName = "WebAPI"

PluginName is the name of the web API plugin.

Variables

var Parameters = &ParametersDefinition{}

Parameters contains the configuration used by the webapi 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.

Types

type ParametersDefinition

type ParametersDefinition struct {
	// BindAddress defines the bind address for the web API.
	BindAddress string `default:"127.0.0.1:8080" usage:"the bind address for the web API"`
	BasicAuth   struct {
		// Enabled defines whether basic HTTP authentication is required to access the API.
		Enabled bool `default:"false" usage:"whether to enable HTTP basic auth"`
		// Username defines the user used by the basic HTTP authentication.
		Username string `default:"goshimmer" usage:"HTTP basic auth username"`
		// Password defines the password used by the basic HTTP authentication.
		Password string `default:"goshimmer" usage:"HTTP basic auth password"`
	} `name:"basic_auth"`
}

ParametersDefinition contains the definition of the parameters used by the webapi plugin.