Scala Website Template
API
Generated with
Scala Website Template/com.alecdorrington/com.alecdorrington.server/com.alecdorrington.server.services/Service

Service

com.alecdorrington.server.services.Service
trait Service(serviceName: String)

The base trait for all API services in this application. Each service is a thematic grouping of API endpoint implementations.

Value parameters

serviceName

The name for this service, used in API documentation.

Attributes

Experimental
true
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CoreService

Members list

Type members

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

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

Value members

Abstract methods

def api: List[Endpoint]

A collection of all endpoints implemented in this service.

A collection of all endpoints implemented in this service.

Attributes

Concrete 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

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.

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

Generated with