restapi

Documentation

Overview

Package restapi Plutonium Service API

The Plutonium Service API provides endpoints to support the operations of the NFT Marketplace.
This document outlines the API's structure, response formats, and capabilities for integration.

Schemes:
  http
Host: plutonium
BasePath: /api/v1
Version: 1.0.0

Consumes:
  - application/json

Produces:
  - application/json

swagger:meta

Index

• Variables
• type Server
  • func NewServer(api *operations.ServiceAPI) *Server
  • func (s *Server) ConfigureAPI()
  • func (s *Server) ConfigureFlags()
  • func (s *Server) Fatalf(f string, args ...interface{})
  • func (s *Server) GetHandler() http.Handler
  • func (s *Server) HTTPListener() (net.Listener, error)
  • func (s *Server) Listen() error
  • func (s *Server) Logf(f string, args ...interface{})
  • func (s *Server) Serve() (err error)
  • func (s *Server) SetAPI(api *operations.ServiceAPI)
  • func (s *Server) SetHandler(handler http.Handler)
  • func (s *Server) Shutdown() error
  • func (s *Server) TLSListener() (net.Listener, error)
  • func (s *Server) UnixListener() (net.Listener, error)

Variables

var (
	// SwaggerJSON embedded version of the swagger document used at generation time
	SwaggerJSON json.RawMessage
	// FlatSwaggerJSON embedded flattened version of the swagger document used at generation time
	FlatSwaggerJSON json.RawMessage
)

Types

type Server

type Server struct {
	Host              string           `long:"host" description:"the IP to listen on" default:"localhost" env:"HOST"`
	TLSCACertificate  flags.Filename   `long:"tls-ca" description:"the certificate authority file to be used with mutual tls auth" env:"TLS_CA_CERTIFICATE"`
	TLSCertificateKey flags.Filename   `long:"tls-key" description:"the private key to use for secure connections" env:"TLS_PRIVATE_KEY"`
	TLSCertificate    flags.Filename   `long:"tls-certificate" description:"the certificate to use for secure connections" env:"TLS_CERTIFICATE"`
	SocketPath        flags.Filename   `long:"socket-path" description:"the unix socket to listen on" default:"/var/run/service.sock"`
	TLSHost           string           `long:"tls-host" description:"the IP to listen on for tls, when not specified it's the same as --host" env:"TLS_HOST"`
	EnabledListeners  []string         `long:"scheme" description:"the listeners to enable, this can be repeated and defaults to the schemes in the swagger spec"`
	TLSPort           int              `long:"tls-port" description:"the port to listen on for secure connections, defaults to a random value" env:"TLS_PORT"`
	TLSWriteTimeout   time.Duration    `long:"tls-write-timeout" description:"maximum duration before timing out write of the response"`
	ReadTimeout       time.Duration    `long:"read-timeout" description:"maximum duration before timing out read of the request" default:"30s"`
	KeepAlive         time.Duration    `` /* 169-byte string literal not displayed */
	TLSListenLimit    int              `long:"tls-listen-limit" description:"limit the number of outstanding requests"`
	TLSKeepAlive      time.Duration    `` /* 160-byte string literal not displayed */
	TLSReadTimeout    time.Duration    `long:"tls-read-timeout" description:"maximum duration before timing out read of the request"`
	WriteTimeout      time.Duration    `long:"write-timeout" description:"maximum duration before timing out write of the response" default:"30s"`
	ListenLimit       int              `long:"listen-limit" description:"limit the number of outstanding requests"`
	Port              int              `long:"port" description:"the port to listen on for insecure connections, defaults to a random value" env:"PORT"`
	MaxHeaderSize     flagext.ByteSize `` /* 231-byte string literal not displayed */
	CleanupTimeout    time.Duration    `long:"cleanup-timeout" description:"grace period for which to wait before killing idle connections" default:"10s"`
	GracefulTimeout   time.Duration    `long:"graceful-timeout" description:"grace period for which to wait before shutting down the server" default:"15s"`
	// contains filtered or unexported fields
}

Server for the service API

func NewServer

func NewServer(api *operations.ServiceAPI) *Server

NewServer creates a new api service server but does not configure it

func (*Server) ConfigureAPI

func (s *Server) ConfigureAPI()

ConfigureAPI configures the API and handlers.

func (*Server) ConfigureFlags

func (s *Server) ConfigureFlags()

ConfigureFlags configures the additional flags defined by the handlers. Needs to be called before the parser.Parse

func (*Server) Fatalf

func (s *Server) Fatalf(f string, args ...interface{})

Fatalf logs message either via defined user logger or via system one if no user logger is defined. Exits with non-zero status after printing

func (*Server) GetHandler

func (s *Server) GetHandler() http.Handler

GetHandler returns a handler useful for testing

func (*Server) HTTPListener

func (s *Server) HTTPListener() (net.Listener, error)

HTTPListener returns the http listener

func (*Server) Listen

func (s *Server) Listen() error

Listen creates the listeners for the server

func (*Server) Logf

func (s *Server) Logf(f string, args ...interface{})

Logf logs message either via defined user logger or via system one if no user logger is defined.

func (*Server) Serve

func (s *Server) Serve() (err error)

Serve the api

func (*Server) SetAPI

func (s *Server) SetAPI(api *operations.ServiceAPI)

SetAPI configures the server with the specified API. Needs to be called before Serve

func (*Server) SetHandler

func (s *Server) SetHandler(handler http.Handler)

SetHandler allows for setting a http handler on this server

func (*Server) Shutdown

func (s *Server) Shutdown() error

Shutdown server and clean up resources

func (*Server) TLSListener

func (s *Server) TLSListener() (net.Listener, error)

TLSListener returns the https listener

func (*Server) UnixListener

func (s *Server) UnixListener() (net.Listener, error)

UnixListener returns the domain socket listener