api

Documentation

Overview

Package api provides the HTTP server for the stackit-web application.

Index

• type Server
  • func NewServer(cfg ServerConfig, eng engine.Engine, gh github.Client) *Server
  • func (s *Server) Broadcaster() *handlers.EventBroadcaster
  • func (s *Server) Shutdown(ctx context.Context) error
  • func (s *Server) Start() error
• type ServerConfig

Types

type Server

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

Server is the stackit-web HTTP server.

func NewServer

func NewServer(cfg ServerConfig, eng engine.Engine, gh github.Client) *Server

NewServer creates a new API server.

func (*Server) Broadcaster

func (s *Server) Broadcaster() *handlers.EventBroadcaster

Broadcaster returns the event broadcaster for triggering SSE updates.

func (*Server) Shutdown

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

Shutdown gracefully stops the server.

func (*Server) Start

func (s *Server) Start() error

Start begins serving HTTP requests. It blocks until the server is stopped.

type ServerConfig

type ServerConfig struct {
	Port        int
	CORSOrigins []string
	RepoRoot    string
	Remote      string
	APIPrefixes []string
	StaticFS    fs.FS
}

ServerConfig holds configuration for the API server.