httpapi

package

v0.3.0 Latest Latest Go to latest Published: Sep 13, 2026 License: MIT Imports: 10 Imported by: 0

Details

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

Repository

github.com/larsartmann/go-taskqueue

Links

Open Source Insights

Documentation ¶

Overview ¶

Package httpapi is the v0.2 production API for non-Go producers (ADR-0008): enqueue tasks and read queue stats over HTTP with token auth. Unlike the read-only dashboard (`tq serve`), this surface WRITES, so the token is mandatory on every bind (no loopback exemption: API servers are meant to be exposed to other machines).

Index ¶

type Server
- func New(store queue.Store, token string, log *slog.Logger) (*Server, error)
- func (s *Server) Handler() http.Handler
- func (s *Server) ListenAndServe(ctx context.Context, addr string) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Server ¶

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

Server is the write API over one store.

func New ¶

func New(store queue.Store, token string, log *slog.Logger) (*Server, error)

New builds a Server. token must be non-empty: the API refuses to start without one (fail closed, unlike the dashboard's loopback exemption).

func (*Server) Handler ¶

func (s *Server) Handler() http.Handler

Handler returns the routed, auth-guarded API handler.

func (*Server) ListenAndServe ¶

func (s *Server) ListenAndServe(ctx context.Context, addr string) error

ListenAndServe starts the API on addr (e.g. "127.0.0.1:8091") until ctx is cancelled.

Source Files ¶

View all Source files

httpapi.go

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