Documentation
¶
Overview ¶
Package api implements the HTTP API server. All routes follow the REST conventions defined in api-conventions.mdc.
Index ¶
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 HTTP API server.
func New ¶
New creates a Server and registers it with the DI injector. The server is constructed but not started — call StartWithConfig to begin accepting connections.
func (*Server) StartWithConfig ¶
StartWithConfig builds the router from the given ServerConfig and begins accepting HTTP connections. Blocks until ctx is cancelled. Called by the RuntimeManager each time the HTTP service is (re)started.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package apidocs holds OpenAPI response/request shapes referenced from swag comments.
|
Package apidocs holds OpenAPI response/request shapes referenced from swag comments. |
|
Package handler contains HTTP request handlers for the API server.
|
Package handler contains HTTP request handlers for the API server. |
Click to show internal directories.
Click to hide internal directories.