restapi

Documentation

Index

• Constants
• Variables
• func ErrorHandler() func(error, echo.Context)
• func GetAcceptHeaderContentType(c echo.Context, supportedContentTypes ...string) (string, error)
• func GetRequestContentType(c echo.Context, supportedContentTypes ...string) (string, error)
• func JSONResponse(c echo.Context, statusCode int, result interface{}) error
• func ParseBlockIDParam(c echo.Context) (iotago.BlockID, error)
• func ParseMilestoneIDParam(c echo.Context) (*iotago.MilestoneID, error)
• func ParseMilestoneIndexParam(c echo.Context, paramName string) (iotago.MilestoneIndex, error)
• func ParseOutputIDParam(c echo.Context) (iotago.OutputID, error)
• func ParseOutputTypeQueryParam(c echo.Context) (*iotago.OutputType, error)
• func ParsePeerIDParam(c echo.Context) (peer.ID, error)
• func ParseTransactionIDParam(c echo.Context) (iotago.TransactionID, error)
• type AllowedRoute
• type DynamicProxy
  • func NewDynamicProxy(e *echo.Echo, prefix string) *DynamicProxy
  • func (p *DynamicProxy) AddGroup(prefix string) *echo.Group
  • func (p *DynamicProxy) AddReverseProxy(prefix string, host string, port uint32) error
  • func (p *DynamicProxy) RemoveReverseProxy(prefix string)
• type HTTPErrorResponse
• type HTTPErrorResponseEnvelope

Constants

const (
	// ParameterBlockID is used to identify a block by its ID.
	ParameterBlockID = "blockID"

	// ParameterTransactionID is used to identify a transaction by its ID.
	ParameterTransactionID = "transactionID"

	// ParameterOutputID is used to identify an output by its ID.
	ParameterOutputID = "outputID"

	// ParameterMilestoneIndex is used to identify a milestone by index.
	ParameterMilestoneIndex = "milestoneIndex"

	// ParameterMilestoneID is used to identify a milestone by its ID.
	ParameterMilestoneID = "milestoneID"

	// ParameterPeerID is used to identify a peer.
	ParameterPeerID = "peerID"

	// QueryParameterOutputType is used to filter for a certain output type.
	QueryParameterOutputType = "type"
)

const (
	MIMEApplicationVendorIOTASerializerV1 = "application/vnd.iota.serializer-v1"
)

Variables

var (
	// ErrInvalidParameter defines the invalid parameter error.
	ErrInvalidParameter = echo.NewHTTPError(http.StatusBadRequest, "invalid parameter")

	// ErrNotAcceptable defines the not acceptable error.
	ErrNotAcceptable = echo.NewHTTPError(http.StatusNotAcceptable)
)

Functions

func ErrorHandler

func ErrorHandler() func(error, echo.Context)

func GetAcceptHeaderContentType

func GetAcceptHeaderContentType(c echo.Context, supportedContentTypes ...string) (string, error)

func GetRequestContentType

func GetRequestContentType(c echo.Context, supportedContentTypes ...string) (string, error)

func JSONResponse

func JSONResponse(c echo.Context, statusCode int, result interface{}) error

JSONResponse sends the JSON response with status code.

func ParseBlockIDParam

func ParseBlockIDParam(c echo.Context) (iotago.BlockID, error)

func ParseMilestoneIDParam

func ParseMilestoneIDParam(c echo.Context) (*iotago.MilestoneID, error)

func ParseMilestoneIndexParam

func ParseMilestoneIndexParam(c echo.Context, paramName string) (iotago.MilestoneIndex, error)

func ParseOutputIDParam

func ParseOutputIDParam(c echo.Context) (iotago.OutputID, error)

func ParseOutputTypeQueryParam

func ParseOutputTypeQueryParam(c echo.Context) (*iotago.OutputType, error)

func ParsePeerIDParam

func ParsePeerIDParam(c echo.Context) (peer.ID, error)

func ParseTransactionIDParam

func ParseTransactionIDParam(c echo.Context) (iotago.TransactionID, error)

Types

type AllowedRoute

type AllowedRoute func(echo.Context) bool

AllowedRoute defines a function to allow or disallow routes.

type DynamicProxy

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

func NewDynamicProxy

func NewDynamicProxy(e *echo.Echo, prefix string) *DynamicProxy

func (*DynamicProxy) AddGroup

func (p *DynamicProxy) AddGroup(prefix string) *echo.Group

func (*DynamicProxy) AddReverseProxy

func (p *DynamicProxy) AddReverseProxy(prefix string, host string, port uint32) error

func (*DynamicProxy) RemoveReverseProxy

func (p *DynamicProxy) RemoveReverseProxy(prefix string)

type HTTPErrorResponse

type HTTPErrorResponse struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

HTTPErrorResponse defines the error struct for the HTTPErrorResponseEnvelope.

type HTTPErrorResponseEnvelope

type HTTPErrorResponseEnvelope struct {
	Error HTTPErrorResponse `json:"error"`
}

HTTPErrorResponseEnvelope defines the error response schema for node API responses.