tequilapi

Documentation

Overview

Package tequilapi Tequila API

The purpose of this documentation is to provide developers an insight of how to interact with Mysterium Node via Tequila API. This should demonstrate all the possible API calls with described parameters and responses.

Host: 127.0.0.1:4050

Consumes:
- application/json

Produces:
- application/json

Version: dev

swagger:meta

Index

• func NewListener(network, address string) (net.Listener, error)
• func NewNoopListener() (net.Listener, error)
• func NewTestClient(t assert.TestingT, address string) *testClient
• type APIServer
  • func NewNoopAPIServer() APIServer
  • func NewServer(listener net.Listener, nodeOptions node.Options, ...) (APIServer, error)

Functions

func NewListener

func NewListener(network, address string) (net.Listener, error)

NewListener returns tequilapi listener.

func NewNoopListener

func NewNoopListener() (net.Listener, error)

NewNoopListener returns noop tequilapi listener.

func NewTestClient

func NewTestClient(t assert.TestingT, address string) *testClient

NewTestClient returns client for making test requests

Types

type APIServer

type APIServer interface {
	Wait() error
	StartServing()
	Stop()
	Address() (string, error)
}

APIServer interface represents control methods for underlying http api server

func NewNoopAPIServer

func NewNoopAPIServer() APIServer

NewNoopAPIServer returns noop api server which is used to disable tequilapi HTTP server.

func NewServer

func NewServer(
	listener net.Listener,
	nodeOptions node.Options,
	authenticator jwtAuthenticator,
	handlers []func(e *gin.Engine) error,
) (APIServer, error)

NewServer creates http api server for given address port and http handler