api

Documentation

Index

• Variables
• func NewHTTPServer(opts ...component.Option) (component.Component, error)
• func RegistCustomHandlers(name, path, method string, fn gin.HandlerFunc)
• type API
  • func (*API) TableName() string
• type InnerResult
• type Response

Variables

var TableName = "api"

TableName default api

Functions

func NewHTTPServer

func NewHTTPServer(opts ...component.Option) (component.Component, error)

NewHTTPServer new api service

func RegistCustomHandlers

func RegistCustomHandlers(name, path, method string, fn gin.HandlerFunc)

RegistCustomHandlers register customer's handlers

Types

type API

type API struct {
	ID             string `xorm:"id"`
	Name           string `xorm:"name"`
	ServiceDomain  string `xorm:"service_domain"`
	ServiceName    string `xorm:"service_name"`
	ServiceVersion string `xorm:"service_version"`
	Topic          string `xorm:"topic"`
	Status         string `xorm:"status"`
}

API api struct

func (*API) TableName

func (*API) TableName() string

TableName database table name

type InnerResult

type InnerResult struct {
	HTTPCode    int
	RedirectURL string
	Body        interface{}
}

InnerResult result of running component

type Response

type Response struct {
	TraceID   string      `json:"trace_id"`
	TraceIP   string      `json:"trace_ip"`
	Code      uint64      `json:"code"`
	Namespace string      `json:"namespace,omitempty"`
	Msg       string      `json:"msg,omitempty"`
	Result    interface{} `json:"result"`
}

Response response