apisix

Documentation

Index

• Variables
• func GetResourceUniqueKey(resource interface{}) string
• type Client
• type Cluster
  • func NewCluster(ctx context.Context, conf config.ClientConfig) (Cluster, error)
• type Consumer
• type ConsumerGroup
• type GlobalRule
• type IntOrString
  • func (ios *IntOrString) UnmarshalJSON(p []byte) error
• type PluginConfig
• type PluginMetadata
• type ResourceClient
• type Route
• type SSL
• type Service
• type StreamRoute
• type Upstream

Variables

var (
	ErrNotFound         = fmt.Errorf("not found")
	ErrStillInUse       = errors.New("still in use") // We should use force mode
	ErrFunctionDisabled = errors.New("function disabled")
)

Functions

func GetResourceUniqueKey

func GetResourceUniqueKey(resource interface{}) string

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

type Cluster

type Cluster interface {
	Route() Route
	Service() Service
	Consumer() Consumer
	SSL() SSL
	GlobalRule() GlobalRule
	PluginConfig() PluginConfig
	ConsumerGroup() ConsumerGroup
	PluginMetadata() PluginMetadata
	StreamRoute() StreamRoute
	Upstream() Upstream
}

func NewCluster

func NewCluster(ctx context.Context, conf config.ClientConfig) (Cluster, error)

type Consumer

type Consumer interface {
	ResourceClient[types.Consumer]
}

type ConsumerGroup

type ConsumerGroup interface {
	ResourceClient[types.ConsumerGroup]
}

type GlobalRule

type GlobalRule interface {
	ResourceClient[types.GlobalRule]
}

type IntOrString

type IntOrString struct {
	IntValue int `json:"int_value"`
}

IntOrString processing number and string types, after json deserialization will output int

func (*IntOrString) UnmarshalJSON

func (ios *IntOrString) UnmarshalJSON(p []byte) error

type PluginConfig

type PluginConfig interface {
	ResourceClient[types.PluginConfig]
}

type PluginMetadata

type PluginMetadata interface {
	ResourceClient[types.PluginMetadata]
}

type ResourceClient

type ResourceClient[T any] interface {
	Get(ctx context.Context, name string) (*T, error)
	List(ctx context.Context) ([]*T, error)
	Create(ctx context.Context, ups *T) (*T, error)
	Delete(ctx context.Context, name string) error
	Update(ctx context.Context, ups *T) (*T, error)
	Validate(ctx context.Context, resource *T) error
}

type Route

type Route interface {
	ResourceClient[types.Route]
}

type SSL

type SSL interface {
	ResourceClient[types.SSL]
}

type Service

type Service interface {
	ResourceClient[types.Service]
}

type StreamRoute

type StreamRoute interface {
	ResourceClient[types.StreamRoute]
}

type Upstream

type Upstream interface {
	ResourceClient[types.Upstream]
}