tapir-core
API
Generated with
tapir-core/sttp.tapir/sttp.tapir.model

sttp.tapir.model

package sttp.tapir.model

Members list

Type members

Classlikes

case class ConnectionInfo(local: Option[InetSocketAddress], remote: Option[InetSocketAddress], secure: Option[Boolean])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ConnectionInfo

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Delimited[DELIMITER <: String, T](values: List[T])

Used to represent lists of values delimited with DELIMITER.

Used to represent lists of values delimited with DELIMITER.

Attributes

See also
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait ServerRequest extends RequestMetadata

Implement for specific request representation of a particular server. Consider overriding ServerRequest#uri and ServerRequest#showShort for a backend-specific implementation of constructing the Uri and printing the path + query params. This way you'll avoid a performance overhead of parsing sttp.model.Uri. See https://softwaremill.com/benchmarking-tapir-part-2/ for more details.

Implement for specific request representation of a particular server. Consider overriding ServerRequest#uri and ServerRequest#showShort for a backend-specific implementation of constructing the Uri and printing the path + query params. This way you'll avoid a performance overhead of parsing sttp.model.Uri. See https://softwaremill.com/benchmarking-tapir-part-2/ for more details.

Attributes

Supertypes
trait RequestMetadata
trait HasHeaders
class Object
trait Matchable
class Any
Known subtypes
class ServerRequestOverride(methodOverride: Option[Method], uriOverride: Option[Uri], protocolOverride: Option[String], connectionInfoOverride: Option[ConnectionInfo], pathSegmentsOverride: Option[List[String]], queryParametersOverride: Option[QueryParams], headersOverride: Option[Seq[Header]], delegate: ServerRequest) extends ServerRequest

Attributes

Supertypes
trait RequestMetadata
trait HasHeaders
class Object
trait Matchable
class Any
Show all
sealed abstract class StatusCodeRange(val range: Int)

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ClientError
object Informational
object Redirect
object ServerError
object Success
object StatusCodeRange

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class UnsupportedWebSocketFrameException(f: WebSocketFrame) extends WebSocketException

Attributes

Supertypes
class WebSocketException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
case class UsernamePassword(username: String, password: Option[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
class WebSocketFrameDecodeFailure(f: WebSocketFrame, failure: Failure) extends WebSocketException

Attributes

Supertypes
class WebSocketException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all

Types

type CommaSeparated[T] = Delimited[",", T]

Used to lookup codecs which split/combine values using a comma.

Used to lookup codecs which split/combine values using a comma.

Attributes

Generated with