server

Documentation

Index

• type Endpoint
  • func (e *Endpoint) Validate() error
• type Endpoints
  • func (e Endpoints) Validate() error
• type HandlerFn
• type IContext

Types

type Endpoint

type Endpoint struct {
	validation.Validatable `json:"-"`
	Name                   string           `json:"name"          yaml:"Name"`
	Method                 http.Method      `json:"method"        yaml:"Method"`
	Path                   string           `json:"path"          yaml:"Path"`
	Description            string           `json:"description"   yaml:"Description"`
	Documentation          string           `json:"documentation" yaml:"Documentation"`
	Deprecated             string           `json:"deprecated"    yaml:"Deprecated"`
	Labels                 data.Map[string] `json:"labels"        yaml:"Labels"`
	IsPublic               bool             `json:"is_public"     yaml:"IsPublic"`
	IsStatic               bool             `json:"is_static"     yaml:"IsStatic"`
	Request                data.IModel      `json:"request"       yaml:"Request"`
	Response               data.IModel      `json:"response"      yaml:"Response"`
	Handlers               []HandlerFn      `json:"-"`
}

Endpoint represents the http server endpoint.

func (*Endpoint) Validate

func (e *Endpoint) Validate() error

Validate makes Endpoint validatable by implementing validation.Validatable interface.

type Endpoints

type Endpoints []*Endpoint

Endpoints represents the http server endpoints.

func (Endpoints) Validate

func (e Endpoints) Validate() error

Validate makes Endpoints validatable by implementing validation.Validatable interface.

type HandlerFn

type HandlerFn func(IContext) error

HandlerFn represents the http server endpoint handler.

type IContext

type IContext interface {
	// Validate makes Endpoint validatable by implementing [validation.Validatable] interface.
	Validate() error
}

IContext represents the http server request context.