sttp.tapir.files
Members list
Type members
Classlikes
Value parameters
- defaultFile
-
path segments (relative to the system path from which files are read) of the file to return in case the one requested by the user isn't found. This is useful for SPA apps, where the same main application file needs to be returned regardless of the path.
- fileFilter
-
A file will be exposed only if this function returns
true
.
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
FilesOptions.type
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
Resources.type
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
StaticErrorOutput.type
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
StaticOutput.type
Static content endpoints, including files and resources.
Static content endpoints, including files and resources.
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
Value members
Concrete methods
Inherited methods
A server endpoint, which exposes a single file from local storage found at systemPath
, using the given path
.
A server endpoint, which exposes a single file from local storage found at systemPath
, using the given path
.
staticFileGetServerEndpoint("static" / "hello.html")("/home/app/static/data.html")
Attributes
- Inherited from:
- TapirStaticContentEndpoints
Attributes
- Inherited from:
- TapirStaticContentEndpoints
A server endpoint, which exposes files from local storage found at systemPath
, using the given prefix
. Typically, the prefix is a path, but it can also contain other inputs. For example:
A server endpoint, which exposes files from local storage found at systemPath
, using the given prefix
. Typically, the prefix is a path, but it can also contain other inputs. For example:
staticFilesGetServerEndpoint("static" / "files")("/home/app/static")
A request to /static/files/css/styles.css
will try to read the /home/app/static/css/styles.css
file.
Attributes
- Inherited from:
- TapirStaticContentEndpoints
A server endpoint, used to verify if sever supports range requests for file under particular path Additionally it verify file existence and returns its size
A server endpoint, used to verify if sever supports range requests for file under particular path Additionally it verify file existence and returns its size
Attributes
- Inherited from:
- TapirStaticContentEndpoints
Create a pair of endpoints (head, get) for exposing files from local storage found at systemPath
, using the given prefix
. Typically, the prefix is a path, but it can also contain other inputs. For example:
Create a pair of endpoints (head, get) for exposing files from local storage found at systemPath
, using the given prefix
. Typically, the prefix is a path, but it can also contain other inputs. For example:
staticFilesServerEndpoints("static" / "files")("/home/app/static")
A request to /static/files/css/styles.css
will try to read the /home/app/static/css/styles.css
file.
Attributes
- Inherited from:
- TapirStaticContentEndpoints
A server endpoint, which exposes a single resource available from the given classLoader
at resourcePath
, using the given path
.
A server endpoint, which exposes a single resource available from the given classLoader
at resourcePath
, using the given path
.
staticResourceGetServerEndpoint("static" / "hello.html")(classOf[App].getClassLoader, "app/data.html")
Attributes
- Inherited from:
- TapirStaticContentEndpoints
Attributes
- Inherited from:
- TapirStaticContentEndpoints
A server endpoint, which exposes resources available from the given classLoader
, using the given prefix
. Typically, the prefix is a path, but it can also contain other inputs. For example:
A server endpoint, which exposes resources available from the given classLoader
, using the given prefix
. Typically, the prefix is a path, but it can also contain other inputs. For example:
staticResourcesGetServerEndpoint("static" / "files")(classOf[App].getClassLoader, "app")
A request to /static/files/css/styles.css
will try to read the /app/css/styles.css
resource.
Attributes
- Inherited from:
- TapirStaticContentEndpoints
A server endpoint, which can be used to verify the existence of a resource under given path.
A server endpoint, which can be used to verify the existence of a resource under given path.
Attributes
- Inherited from:
- TapirStaticContentEndpoints
Create a pair of endpoints (head, get) for exposing resources available from the given classLoader
, using the given prefix
. Typically, the prefix is a path, but it can also contain other inputs. For example:
Create a pair of endpoints (head, get) for exposing resources available from the given classLoader
, using the given prefix
. Typically, the prefix is a path, but it can also contain other inputs. For example:
resourcesServerEndpoints("static" / "files")(classOf[App].getClassLoader, "app")
A request to /static/files/css/styles.css
will try to read the /app/css/styles.css
resource.
Attributes
- Inherited from:
- TapirStaticContentEndpoints
Inherited fields
Attributes
- Inherited from:
- TapirStaticContentEndpoints
Attributes
- Inherited from:
- TapirStaticContentEndpoints