restruntime

README

runtime for REST-based API.

Documentation

Index

• func ApiServer(routes []route)
• func RunServer()
• type BooleanInfo
• type JSONResult
• type SSHRUNReqInfo
• type SimpleMsg
• type StatusInfo

Functions

func ApiServer

func ApiServer(routes []route)

================ REST API Server: setup & start

func RunServer

func RunServer()

Types

type BooleanInfo

type BooleanInfo struct {
	Result string // true or false
}

REST API Return struct for boolean type

type JSONResult

type JSONResult struct {
}

JSONResult's data field will be overridden by the specific type

type SSHRUNReqInfo

type SSHRUNReqInfo struct {
	UserName   string   // ex) "root"
	PrivateKey []string // ex)   ["-----BEGIN RSA PRIVATE KEY-----",
	//          "MIIEoQIBAAKCAQEArVNOLwMIp5VmZ4VPZotcoCHdEzimKalAsz+ccLfvAA1Y2ELH",
	//          "..."]
	ServerPort string // ex) "node12:22"
	Command    string // ex) "hostname"
}

type SimpleMsg

type SimpleMsg struct {
	Message string `json:"message" example:"Any message"`
}

JSON Simple message struct

type StatusInfo

type StatusInfo struct {
	Status string // PENDING | RUNNING | SUSPENDING | SUSPENDED | REBOOTING | TERMINATING | TERMINATED
}