api

Documentation

Index

• Constants
• type API
  • func NewAPI(cfg Config) (*API, error)
  • func (s *API) Shutdown(ctx context.Context) error
  • func (s *API) Start() error
  • func (s *API) SubmitJob(ctx context.Context, ji *input.Job) (*tork.Job, error)
• type Config
• type Context
  • func (c *Context) Bind(i any) error
  • func (c *Context) Done() <-chan any
  • func (c *Context) Error(code int, err error)
  • func (c *Context) Get(key string) any
  • func (c *Context) JSON(code int, data any) error
  • func (c *Context) NoContent(code int) error
  • func (c *Context) Request() *http.Request
  • func (c *Context) Response() http.ResponseWriter
  • func (c *Context) String(code int, s string) error
• type HealthResponse
• type Middleware

Constants

const (
	MIN_PORT = 8000
	MAX_PORT = 8100
)

Types

type API

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

func NewAPI

func NewAPI(cfg Config) (*API, error)

@host localhost:8000 @BasePath / @schemes http

func (*API) Shutdown

func (s *API) Shutdown(ctx context.Context) error

func (*API) Start

func (s *API) Start() error

func (*API) SubmitJob

func (s *API) SubmitJob(ctx context.Context, ji *input.Job) (*tork.Job, error)

type Config

type Config struct {
	Broker     mq.Broker
	DataStore  datastore.Datastore
	Address    string
	Middleware Middleware
	Endpoints  map[string]web.HandlerFunc
	Enabled    map[string]bool
}

type Context

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

func (*Context) Bind

func (c *Context) Bind(i any) error

func (*Context) Done

func (c *Context) Done() <-chan any

func (*Context) Error

func (c *Context) Error(code int, err error)

func (*Context) Get

func (c *Context) Get(key string) any

func (*Context) JSON

func (c *Context) JSON(code int, data any) error

func (*Context) NoContent

func (c *Context) NoContent(code int) error

func (*Context) Request

func (c *Context) Request() *http.Request

func (*Context) Response

func (c *Context) Response() http.ResponseWriter

func (*Context) String

func (c *Context) String(code int, s string) error

type HealthResponse

type HealthResponse struct {
	Status string `json:"status"`
}

type Middleware

type Middleware struct {
	Web  []web.MiddlewareFunc
	Job  []job.MiddlewareFunc
	Task []task.MiddlewareFunc
	Echo []echo.MiddlewareFunc
}