com.alecdorrington.assetloader.tapir
Members list
Type members
Classlikes
A Tapir endpoint definition for serving static assets.
A Tapir endpoint definition for serving static assets.
This is the cross-platform base for AssetService, which adds the server-side logic on JVM.
Value parameters
- externalPath
-
The URL path prefix for the endpoint, e.g. "
assets".
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class AssetService[F]
A Tapir service for serving static assets loaded by an AssetLoader.
A Tapir service for serving static assets loaded by an AssetLoader.
Type parameters
- F
-
The effect type (e.g.
FutureorIO).
Value parameters
- externalPath
-
The URL path prefix for the endpoint, e.g. "
assets". - internalPath
-
The root directory on the server's file system where assets are stored, relative to the directory of the running server process, e.g. "
src/main/resources". - maxAge
-
The maximum age (in seconds) for which an asset should be considered fresh for caching purposes. Caching is disabled by default (
0).
Attributes
- Supertypes
The base trait for all API services in this library. Each service is a thematic grouping of API endpoint implementations.
The base trait for all API services in this library. Each service is a thematic grouping of API endpoint implementations.
Type parameters
- Capabilities
-
Capabilities required by this service (e.g.
WebSocketorStreams[IO]). - F
-
The effect type (e.g.
FutureorIO).
Value parameters
- serviceName
-
The name of this service, used in API documentation.
- serviceVersion
-
The version of this service, used in API documentation.
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class AssetService[F]