server

Documentation

Overview

Package server Algod REST API.

API Endpoint for AlgoD Operations.

Schemes: http
Host: localhost
BasePath: /
Version: 0.0.1
License:
Contact: contact@algorand.com

Consumes:
- application/json

Produces:
- application/json

Security:
- api_key:

SecurityDefinitions:
api_key:
  type: apiKey
  name: X-Algo-API-Token
  in: header
  description: >-
    Generated header parameter. This token can be generated using the Goal command line tool. Example value
    ='b7e384d0317b8050ce45900a94a1931e28540e1f69b2d242b424659c341b4697'
  required: true
  x-example: b7e384d0317b8050ce45900a94a1931e28540e1f69b2d242b424659c341b4697

swagger:meta --- Currently, server implementation annotations serve as the API ground truth. From that, we use go-swagger to generate a swagger spec.

Autogenerate the swagger json - automatically run by the 'make build' step. Base path must be a fully specified package name (else, it seems that swagger feeds a relative path to loader.Config.Import(), and that breaks the vendor directory if the source is symlinked from elsewhere)

Index

• func NewRouter(logger logging.Logger, node *node.AlgorandFullNode, apiToken string) *mux.Router

Functions

func NewRouter

func NewRouter(logger logging.Logger, node *node.AlgorandFullNode, apiToken string) *mux.Router

NewRouter builds and returns a new router from routes