package
1.8.2
Repository: https://github.com/multiversx/mx-chain-go.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

RespondWith will respond with the generic API response.
RespondWithInternalError should be called when the request cannot be satisfied due to an internal error.
RespondWithSuccess should be called when the request can be satisfied.
RespondWithValidationError should be called when the request cannot be satisfied due to a (request) validation error.

# Constants

After indicates that the middleware should be used after the base endpoint handler.
Before indicates that the middleware should be used before the base endpoint handler.
ReturnCodeInternalError defines a request which hasn't been executed successfully due to an internal error.
ReturnCodeRequestError defines a request which hasn't been executed successfully due to a bad request received.
ReturnCodeSuccess defines a successful request.
ReturnCodeSystemBusy defines a request which hasn't been executed successfully due to too many requests.

# Structs

AdditionalMiddleware holds the data needed for adding a middleware to an API endpoint.
EndpointHandlerData holds the items needed for creating a new gin HTTP endpoint.
GenericAPIResponse defines the structure of all responses on API endpoints.

# Interfaces

ApiFacadeHandler interface defines methods that can be used by the web server to interact with the node.
FacadeHandler defines all the methods that a facade should implement.
GroupHandler defines the actions needed to be performed by a gin API group.
HttpServerCloser defines the basic actions of starting and closing that a web server should be able to do.
MiddlewareProcessor defines a processor used internally by the web server when processing requests.
UpgradeableHttpServerHandler defines the actions that an upgradeable http server need to do.

# Type aliases

MiddlewarePosition is the type that specifies the position of a middleware relative to the base endpoint handler.
ReturnCode defines the type defines to identify return codes.