rest

Documentation

Overview

Package rest API.

the purpose of this application is to provide an application that is using plain go code to define an API

This should demonstrate all the possible comment annotations that are available to turn go code into a fully compliant swagger 2.0 spec

Terms Of Service:

there are no TOS at this moment, use at your own risk we take no responsibility

Schemes: http, https
Version: 0.0.1
License: MIT http://opensource.org/licenses/MIT

Security:
- api_key:

SecurityDefinitions:
api_key:
     type: apiKey
     name: KEY
     in: header

swagger:meta

Index

• func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router)
• func RegisterRoutesV2(cliCtx context.CLIContext, r *mux.Router)
• type BookParam
• type BookResponse
• type BroadcastReq
• type OrderDetailParam
• type OrderResponse

Functions

func RegisterRoutes

func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router)

RegisterRoutes - Central function to define routes that get registered by the main application

func RegisterRoutesV2

func RegisterRoutesV2(cliCtx context.CLIContext, r *mux.Router)

nolint

Types

type BookParam

type BookParam struct {
	// token pair string
	// Required: true
	// in: query
	Product string `json:"product"`
}

BookParam : order depth book param swagger:parameters getDepthBook

type BookResponse

type BookResponse struct {
	// in: body
	Body keeper.BookRes
}

BookResponse : Order depth book swagger:response BookResponse

type BroadcastReq

type BroadcastReq struct {
	Tx    auth.StdTx `json:"tx"`
	Mode  string     `json:"mode"`
	Nonce uint64     `json:"nonce"`
}

BroadcastReq defines a tx broadcasting request.

type OrderDetailParam

type OrderDetailParam struct {
	// an id of order
	// Required: true
	// in: path
	OrderID string `json:"order_id"`
}

OrderDetailParam : order detail param swagger:parameters getOrderDetail

type OrderResponse

type OrderResponse struct {
	// in: body
	Body types.Order
}

OrderResponse : Order Info swagger:response OrderResponse