CoreService

com.alecdorrington.server.services.CoreService
object CoreService extends Service

The implementation of the API endpoints specified in CoreApi. These are general endpoints which are used across the entire application.

Attributes

Experimental
true
Graph
Supertypes
trait Service
class Object
trait Matchable
class Any
Self type

Members list

Type members

Inherited types

final type Capabilities = WebSockets & Fs2Streams[IO]

The kinds of capabilities that API endpoints in this application have.

The kinds of capabilities that API endpoints in this application have.

Attributes

Inherited from:
Service
final type Endpoint = ServerEndpoint[Capabilities, IO]

The type of all API endpoints in this application.

The type of all API endpoints in this application.

Attributes

Inherited from:
Service

Value members

Concrete fields

lazy val api: List[Endpoint]

A collection of all endpoints implemented in this service.

A collection of all endpoints implemented in this service.

Attributes

lazy val assets: Endpoint

An endpoint that serves static files from the client's "resources" directory. Returns 304 Not Modified if the client's cached ETag matches.

An endpoint that serves static files from the client's "resources" directory. Returns 304 Not Modified if the client's cached ETag matches.

Attributes

lazy val health: Endpoint

A health check endpoint that confirms the server is running and able to accept requests.

A health check endpoint that confirms the server is running and able to accept requests.

Attributes

lazy val hotReload: Endpoint

An endpoint that establishes a websocket connection so that the client is able to detect when the server has been restarted, at which time the client will proceed by reloading the page.

An endpoint that establishes a websocket connection so that the client is able to detect when the server has been restarted, at which time the client will proceed by reloading the page.

Attributes

Note

Only available in development mode.

lazy val index: Endpoint

Serves the index page of the website.

Serves the index page of the website.

Attributes

Inherited fields

final lazy val all: List[Endpoint]

A combination of the endpoints from api, docs, and metrics.

A combination of the endpoints from api, docs, and metrics.

Attributes

Inherited from:
Service
final lazy val docs: List[Endpoint]

Endpoints used to browse API documentation, generated from the spec using Swagger.

Endpoints used to browse API documentation, generated from the spec using Swagger.

Attributes

Note

Only available in development mode.

Inherited from:
Service
final lazy val metrics: Endpoint

An endpoint that serves metrics about this application, in a format that can be scraped by Prometheus.

An endpoint that serves metrics about this application, in a format that can be scraped by Prometheus.

Attributes

Inherited from:
Service