api_json_types

package module

v0.0.5 Latest Latest Go to latest Published: Nov 5, 2021 License: MIT Imports: 3 Imported by: 3

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/myfantasy/api_json_types

Links

Open Source Insights

README ¶

api_json_types

Documentation ¶

Index ¶

Constants
Variables
type Action
type Api
type CommandDescription
type CommandRequest
- func CreateRequest(objectType ObjectType, action Action, objectName string, v interface{}) (cr *CommandRequest, err *mft.Error)
- func CreateUserRequest(objectType ObjectType, action Action, objectName string, v interface{}, ...) (cr *CommandRequest, err *mft.Error)
- func (cr *CommandRequest) Unmarshal(v interface{}) *mft.Error
- func (cr *CommandRequest) UserName() string
type CommandResponce
- func CreateResponce(v interface{}, err *mft.Error) (cr *CommandResponce)
- func (cr *CommandResponce) Unmarshal(v interface{}) *mft.Error
type ObjectType

Constants ¶

View Source

const ErrorType mft.ErrorLabelName = "error_type"

View Source

const ErrorTypeInternalError string = "internal_error"

View Source

const ErrorTypeInvalidParams string = "invalid_params"

Variables ¶

View Source

var Errors map[int]string = map[int]string{
	20000000: "api_json_types.CommandRequest.Unmarshal: fail",
	20000010: "api_json_types.CreateRequest: Marshal fail",
	20000011: "api_json_types.CreateUserRequest: Marshal fail",
	20000020: "api_json_types.CommandResponce.Unmarshal: fail",
	20000030: "api_json_types.CreateResponce: fail",
}

Errors codes and description

Functions ¶

This section is empty.

Types ¶

type Action ¶ added in v0.0.3

type Action string

type Api ¶

type Api interface {
	AllowedCommands() []CommandDescription
	DoRequest(ctx context.Context, req *CommandRequest) *CommandResponce
}

type CommandDescription ¶

type CommandDescription struct {
	ObjectType  ObjectType `json:"object_type,omitempty"`
	Action      Action     `json:"action,omitempty"`
	Description string     `json:"description,omitempty"`
}

type CommandRequest ¶

type CommandRequest struct {
	ObjectType ObjectType      `json:"object_type,omitempty"`
	Action     Action          `json:"action,omitempty"`
	ObjectName string          `json:"object_name,omitempty"`
	Params     json.RawMessage `json:"params,omitempty"`
	User       string          `json:"user,omitempty"`
}

func CreateRequest ¶

func CreateRequest(objectType ObjectType, action Action, objectName string, v interface{}) (cr *CommandRequest, err *mft.Error)

func CreateUserRequest ¶

func CreateUserRequest(objectType ObjectType, action Action, objectName string, v interface{}, userName string) (cr *CommandRequest, err *mft.Error)

func (*CommandRequest) Unmarshal ¶

func (cr *CommandRequest) Unmarshal(v interface{}) *mft.Error

func (*CommandRequest) UserName ¶

func (cr *CommandRequest) UserName() string

type CommandResponce ¶

type CommandResponce struct {
	Error  *mft.Error      `json:"error,omitempty"`
	Result json.RawMessage `json:"result,omitempty"`
}

func CreateResponce ¶

func CreateResponce(v interface{}, err *mft.Error) (cr *CommandResponce)

func (*CommandResponce) Unmarshal ¶

func (cr *CommandResponce) Unmarshal(v interface{}) *mft.Error

type ObjectType ¶ added in v0.0.3

type ObjectType string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL