Merge pull request #17791 from spray/wip-docs2-mathias
More scala-side HTTP docs
This commit is contained in:
drewhk
commit
62865ff927
147 changed files with 458 additions and 338 deletions
|
|
@ -64,3 +64,8 @@ Currently Akka HTTP doesn't implement client-side request timeout checking itsel
|
|||
as a more general purpose streaming infrastructure feature.
|
||||
However, akka-stream should soon provide such a feature.
|
||||
|
||||
|
||||
Stand-Alone HTTP Layer Usage
|
||||
----------------------------
|
||||
|
||||
// TODO
|
||||
|
|
@ -1,4 +1,40 @@
|
|||
.. _clientSideHTTPS:
|
||||
|
||||
Client-Side HTTPS Support
|
||||
=========================
|
||||
|
||||
TODO
|
||||
Akka HTTP supports TLS encryption on the client-side as well as on the :ref:`server-side <serverSideHTTPS>`.
|
||||
|
||||
The central vehicle for configuring encryption is the ``HttpsContext``, which is defined as such:
|
||||
|
||||
.. includecode2:: /../../akka-http-core/src/main/scala/akka/http/scaladsl/Http.scala
|
||||
:snippet: https-context-impl
|
||||
|
||||
In addition to the ``outgoingConnection``, ``newHostConnectionPool`` and ``cachedHostConnectionPool`` methods the
|
||||
`akka.http.scaladsl.Http`_ extension also defines ``outgoingConnectionTls``, ``newHostConnectionPoolTls`` and
|
||||
``cachedHostConnectionPoolTls``. These methods work identically to their counterparts without the ``-Tls`` suffix,
|
||||
with the exception that all connections will always be encrypted.
|
||||
|
||||
The ``singleRequest`` and ``superPool`` methods determine the encryption state via the scheme of the incoming request,
|
||||
i.e. requests to an "https" URI will be encrypted, while requests to an "http" URI won't.
|
||||
|
||||
The encryption configuration for all HTTPS connections, i.e. the ``HttpsContext`` is determined according to the
|
||||
following logic:
|
||||
|
||||
1. If the optional ``httpContext`` method parameter is defined it contains the configuration to be used (and thus
|
||||
takes precedence over any potentially set default client-side ``HttpsContext``).
|
||||
|
||||
2. If the optional ``httpContext`` method parameter is undefined (which is the default) the default client-side
|
||||
``HttpsContext`` is used, which can be set via the ``setDefaultClientHttpsContext`` on the ``Http`` extension.
|
||||
|
||||
3. If no default client-side ``HttpsContext`` has been set via the ``setDefaultClientHttpsContext`` on the ``Http``
|
||||
extension the default system configuration is used.
|
||||
|
||||
Usually the process is, if the default system TLS configuration is not good enough for your application's needs,
|
||||
that you configure a custom ``HttpsContext`` instance and set it via ``Http().setDefaultClientHttpsContext``.
|
||||
Afterwards you simply use ``outgoingConnectionTls``, ``newHostConnectionPoolTls``, ``cachedHostConnectionPoolTls``,
|
||||
``superPool`` or ``singleRequest`` without a specific ``httpContext`` argument, which causes encrypted connections
|
||||
to rely on the configured default client-side ``HttpsContext``.
|
||||
|
||||
|
||||
.. _akka.http.scaladsl.Http: @github@/akka-http-core/src/main/scala/akka/http/scaladsl/Http.scala
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ akka-http-core
|
|||
akka-http-core-scala
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. literalinclude:: ../../../../akka-http-scala/src/main/resources/reference.conf
|
||||
.. literalinclude:: ../../../../akka-http/src/main/resources/reference.conf
|
||||
:language: none
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -132,4 +132,25 @@ connection. An often times more convenient alternative is to explicitly add a ``
|
|||
connection when it has been sent out.
|
||||
|
||||
|
||||
// TODO: show an example of using the HTTP layer independently with a BidFlow join
|
||||
.. _serverSideHTTPS:
|
||||
|
||||
Server-Side HTTPS Support
|
||||
-------------------------
|
||||
|
||||
Akka HTTP supports TLS encryption on the server-side as well as on the :ref:`client-side <clientSideHTTPS>`.
|
||||
|
||||
The central vehicle for configuring encryption is the ``HttpsContext``, which is defined as such:
|
||||
|
||||
.. includecode2:: /../../akka-http-core/src/main/scala/akka/http/scaladsl/Http.scala
|
||||
:snippet: https-context-impl
|
||||
|
||||
On the server-side the ``bind``, and ``bindAndHandleXXX`` methods of the `akka.http.scaladsl.Http`_ extension define an
|
||||
optional ``httpsContext`` parameter, which can receive the HTTPS configuration in the form of an ``HttpsContext``
|
||||
instance.
|
||||
If defined encryption is enabled on all accepted connections. Otherwise it is disabled (which is the default).
|
||||
|
||||
|
||||
Stand-Alone HTTP Layer Usage
|
||||
----------------------------
|
||||
|
||||
// TODO
|
||||
|
|
@ -6,133 +6,194 @@ Predefined Directives (alphabetically)
|
|||
=========================================== ============================================================================
|
||||
Directive Description
|
||||
=========================================== ============================================================================
|
||||
:ref:`-authenticateBasic-` ...
|
||||
:ref:`-authenticateBasicAsync-` ...
|
||||
:ref:`-authenticateBasicPF-` ...
|
||||
:ref:`-authenticateBasicPFAsync-` ...
|
||||
:ref:`-authenticateOrRejectWithChallenge-` ...
|
||||
:ref:`-authorize-` ...
|
||||
:ref:`-cancelRejection-` ...
|
||||
:ref:`-cancelRejections-` ...
|
||||
:ref:`-complete-` ...
|
||||
:ref:`-completeOrRecoverWith-` ...
|
||||
:ref:`-completeWith-` ...
|
||||
:ref:`-conditional-` ...
|
||||
:ref:`-cookie-` ...
|
||||
:ref:`-decodeRequest-` ...
|
||||
:ref:`-decodeRequestWith-` ...
|
||||
:ref:`-delete-` ...
|
||||
:ref:`-deleteCookie-` ...
|
||||
:ref:`-encodeResponse-` ...
|
||||
:ref:`-encodeResponseWith-` ...
|
||||
:ref:`-entity-` ...
|
||||
:ref:`-extract-` ...
|
||||
:ref:`-extractClientIP-` ...
|
||||
:ref:`-extractCredentials-` ...
|
||||
:ref:`-extractExecutionContext-` ...
|
||||
:ref:`-extractFlowMaterializer-` ...
|
||||
:ref:`-extractHost-` ...
|
||||
:ref:`-extractLog-` ...
|
||||
:ref:`-extractMethod-` ...
|
||||
:ref:`-extractRequest-` ...
|
||||
:ref:`-extractRequestContext-` ...
|
||||
:ref:`-extractScheme-` ...
|
||||
:ref:`-extractSettings-` ...
|
||||
:ref:`-extractUnmatchedPath-` ...
|
||||
:ref:`-extractUri-` ...
|
||||
:ref:`-failWith-` ...
|
||||
:ref:`-formField-` ...
|
||||
:ref:`-formFields-` ...
|
||||
:ref:`-get-` ...
|
||||
:ref:`-getFromBrowseableDirectories-` ...
|
||||
:ref:`-getFromBrowseableDirectory-` ...
|
||||
:ref:`-getFromDirectory-` ...
|
||||
:ref:`-getFromFile-` ...
|
||||
:ref:`-getFromResource-` ...
|
||||
:ref:`-getFromResourceDirectory-` ...
|
||||
:ref:`-handleExceptions-` ...
|
||||
:ref:`-handleRejections-` ...
|
||||
:ref:`-handleWebsocketMessages-` ...
|
||||
:ref:`-handleWith-` ...
|
||||
:ref:`-head-` ...
|
||||
:ref:`-headerValue-` ...
|
||||
:ref:`-headerValueByName-` ...
|
||||
:ref:`-headerValueByType-` ...
|
||||
:ref:`-headerValuePF-` ...
|
||||
:ref:`-host-` ...
|
||||
:ref:`-listDirectoryContents-` ...
|
||||
:ref:`-logRequest-` ...
|
||||
:ref:`-logRequestResult-` ...
|
||||
:ref:`-logResult-` ...
|
||||
:ref:`-mapInnerRoute-` ...
|
||||
:ref:`-mapRejections-` ...
|
||||
:ref:`-mapRequest-` ...
|
||||
:ref:`-mapRequestContext-` ...
|
||||
:ref:`-mapResponse-` ...
|
||||
:ref:`-mapResponseEntity-` ...
|
||||
:ref:`-mapResponseHeaders-` ...
|
||||
:ref:`-mapRouteResult-` ...
|
||||
:ref:`-mapRouteResultFuture-` ...
|
||||
:ref:`-mapRouteResultPF-` ...
|
||||
:ref:`-mapRouteResultWith-` ...
|
||||
:ref:`-mapRouteResultWithPF-` ...
|
||||
:ref:`-mapSettings-` ...
|
||||
:ref:`-mapUnmatchedPath-` ...
|
||||
:ref:`-method-` ...
|
||||
:ref:`-onComplete-` ...
|
||||
:ref:`-onSuccess-` ...
|
||||
:ref:`-optionalCookie-` ...
|
||||
:ref:`-optionalHeaderValue-` ...
|
||||
:ref:`-optionalHeaderValueByName-` ...
|
||||
:ref:`-optionalHeaderValueByType-` ...
|
||||
:ref:`-optionalHeaderValuePF-` ...
|
||||
:ref:`-options-` ...
|
||||
:ref:`-overrideMethodWithParameter-` ...
|
||||
:ref:`-overrideStatusCode-` ...
|
||||
:ref:`-parameter-` ...
|
||||
:ref:`-parameterMap-` ...
|
||||
:ref:`-parameterMultiMap-` ...
|
||||
:ref:`-parameters-` ...
|
||||
:ref:`-parameterSeq-` ...
|
||||
:ref:`-pass-` ...
|
||||
:ref:`-patch-` ...
|
||||
:ref:`-path-` ...
|
||||
:ref:`-pathEnd-` ...
|
||||
:ref:`-pathEndOrSingleSlash-` ...
|
||||
:ref:`-pathPrefix-` ...
|
||||
:ref:`-pathPrefixTest-` ...
|
||||
:ref:`-pathSingleSlash-` ...
|
||||
:ref:`-pathSuffix-` ...
|
||||
:ref:`-pathSuffixTest-` ...
|
||||
:ref:`-post-` ...
|
||||
:ref:`-provide-` ...
|
||||
:ref:`-put-` ...
|
||||
:ref:`-rawPathPrefix-` ...
|
||||
:ref:`-rawPathPrefixTest-` ...
|
||||
:ref:`-recoverRejections-` ...
|
||||
:ref:`-recoverRejectionsWith-` ...
|
||||
:ref:`-redirect-` ...
|
||||
:ref:`-redirectToNoTrailingSlashIfPresent-` ...
|
||||
:ref:`-redirectToTrailingSlashIfMissing-` ...
|
||||
:ref:`-reject-` ...
|
||||
:ref:`-rejectEmptyResponse-` ...
|
||||
:ref:`-requestEncodedWith-` ...
|
||||
:ref:`-requestEntityEmpty-` ...
|
||||
:ref:`-requestEntityPresent-` ...
|
||||
:ref:`-respondWithDefaultHeader-` ...
|
||||
:ref:`-respondWithDefaultHeaders-` ...
|
||||
:ref:`-respondWithHeader-` ...
|
||||
:ref:`-respondWithHeaders-` ...
|
||||
:ref:`-respondWithHeaders-` ...
|
||||
:ref:`-responseEncodingAccepted-` ...
|
||||
:ref:`-scheme-` ...
|
||||
:ref:`-setCookie-` ...
|
||||
:ref:`-textract-` ...
|
||||
:ref:`-tprovide-` ...
|
||||
:ref:`-validate-` ...
|
||||
:ref:`-withExecutionContext-` ...
|
||||
:ref:`-withFlowMaterializer-` ...
|
||||
:ref:`-withLog-` ...
|
||||
:ref:`-withRangeSupport-` ...
|
||||
:ref:`-withSettings-` ...
|
||||
:ref:`-authenticateBasic-` Wraps the inner route with Http Basic authentication support using a given
|
||||
``Authenticator[T]``
|
||||
:ref:`-authenticateBasicAsync-` Wraps the inner route with Http Basic authentication support using a given
|
||||
``AsyncAuthenticator[T]``
|
||||
:ref:`-authenticateBasicPF-` Wraps the inner route with Http Basic authentication support using a given
|
||||
``AuthenticatorPF[T]``
|
||||
:ref:`-authenticateBasicPFAsync-` Wraps the inner route with Http Basic authentication support using a given
|
||||
``AsyncAuthenticatorPF[T]``
|
||||
:ref:`-authenticateOrRejectWithChallenge-` Lifts an authenticator function into a directive
|
||||
:ref:`-authorize-` Applies the given authorization check to the request
|
||||
:ref:`-cancelRejection-` Adds a ``TransformationRejection`` cancelling all rejections equal to the
|
||||
given one to the rejections potentially coming back from the inner route.
|
||||
:ref:`-cancelRejections-` Adds a ``TransformationRejection`` cancelling all matching rejections
|
||||
to the rejections potentially coming back from the inner route
|
||||
:ref:`-complete-` Completes the request using the given arguments
|
||||
:ref:`-completeOrRecoverWith-` "Unwraps" a ``Future[T]`` and runs the inner route when the future has
|
||||
failed with the error as an extraction of type ``Throwable``
|
||||
:ref:`-completeWith-` Uses the marshaller for a given type to extract a completion function
|
||||
:ref:`-conditional-` Wraps its inner route with support for conditional requests as defined
|
||||
by http://tools.ietf.org/html/rfc7232
|
||||
:ref:`-cookie-` Extracts the ``HttpCookie`` with the given name
|
||||
:ref:`-decodeRequest-` Decompresses the request if it is ``gzip`` or ``deflate`` compressed
|
||||
:ref:`-decodeRequestWith-` Decodes the incoming request using one of the given decoders
|
||||
:ref:`-delete-` Rejects all non-DELETE requests
|
||||
:ref:`-deleteCookie-` Adds a ``Set-Cookie`` response header expiring the given cookies
|
||||
:ref:`-encodeResponse-` Encodes the response with the encoding that is requested by the client
|
||||
via the ``Accept-Encoding`` header (``NoCoding``, ``Gzip`` and ``Deflate``)
|
||||
:ref:`-encodeResponseWith-` Encodes the response with the encoding that is requested by the client
|
||||
via the ``Accept-Encoding`` header (from a user-defined set)
|
||||
:ref:`-entity-` Extracts the request entity unmarshalled to a given type
|
||||
:ref:`-extract-` Extracts a single value using a ``RequestContext ⇒ T`` function
|
||||
:ref:`-extractClientIP-` Extracts the client's IP from either the ``X-Forwarded-``,
|
||||
``Remote-Address`` or ``X-Real-IP`` header
|
||||
:ref:`-extractCredentials-` Extracts the potentially present ``HttpCredentials`` provided with the
|
||||
request's ``Authorization`` header
|
||||
:ref:`-extractExecutionContext-` Extracts the ``ExecutionContext`` from the ``RequestContext``
|
||||
:ref:`-extractFlowMaterializer-` Extracts the ``FlowMaterializer`` from the ``RequestContext``
|
||||
:ref:`-extractHost-` Extracts the hostname part of the Host request header value
|
||||
:ref:`-extractLog-` Extracts the ``LoggingAdapter`` from the ``RequestContext``
|
||||
:ref:`-extractMethod-` Extracts the request method
|
||||
:ref:`-extractRequest-` Extracts the current ``HttpRequest`` instance
|
||||
:ref:`-extractRequestContext-` Extracts the ``RequestContext`` itself
|
||||
:ref:`-extractScheme-` Extracts the URI scheme from the request
|
||||
:ref:`-extractSettings-` Extracts the ``RoutingSettings`` from the ``RequestContext``
|
||||
:ref:`-extractUnmatchedPath-` Extracts the yet unmatched path from the ``RequestContext``
|
||||
:ref:`-extractUri-` Extracts the complete request URI
|
||||
:ref:`-failWith-` Bubbles the given error up the response chain where it is dealt with by the
|
||||
closest :ref:`-handleExceptions-` directive and its ``ExceptionHandler``
|
||||
:ref:`-formField-` Extracts an HTTP form field from the request
|
||||
:ref:`-formFields-` Extracts a number of HTTP form field from the request
|
||||
:ref:`-get-` Rejects all non-GET requests
|
||||
:ref:`-getFromBrowseableDirectories-` Serves the content of the given directories as a file-system browser, i.e.
|
||||
files are sent and directories served as browseable listings
|
||||
:ref:`-getFromBrowseableDirectory-` Serves the content of the given directory as a file-system browser, i.e.
|
||||
files are sent and directories served as browseable listings
|
||||
:ref:`-getFromDirectory-` Completes GET requests with the content of a file underneath a given
|
||||
file-system directory
|
||||
:ref:`-getFromFile-` Completes GET requests with the content of a given file
|
||||
:ref:`-getFromResource-` Completes GET requests with the content of a given class-path resource
|
||||
:ref:`-getFromResourceDirectory-` Completes GET requests with the content of a file underneath a given
|
||||
"class-path resource directory"
|
||||
:ref:`-handleExceptions-` Transforms exceptions thrown during evaluation of the inner route using the
|
||||
given ``ExceptionHandler``
|
||||
:ref:`-handleRejections-` Transforms rejections produced by the inner route using the given
|
||||
``RejectionHandler``
|
||||
:ref:`-handleWebsocketMessages-` Handles websocket requests with the given handler and rejects other requests
|
||||
with a ``ExpectedWebsocketRequestRejection``
|
||||
:ref:`-handleWith-` Completes the request using a given function
|
||||
:ref:`-head-` Rejects all non-HEAD requests
|
||||
:ref:`-headerValue-` Extracts an HTTP header value using a given ``HttpHeader ⇒ Option[T]``
|
||||
function
|
||||
:ref:`-headerValueByName-` Extracts the value of the first HTTP request header with a given name
|
||||
:ref:`-headerValueByType-` Extracts the first HTTP request header of the given type
|
||||
:ref:`-headerValuePF-` Extracts an HTTP header value using a given
|
||||
``PartialFunction[HttpHeader, T]``
|
||||
:ref:`-host-` Rejects all requests with a non-matching host name
|
||||
:ref:`-listDirectoryContents-` Completes GET requests with a unified listing of the contents of all given
|
||||
file-system directories
|
||||
:ref:`-logRequest-` Produces a log entry for every incoming request
|
||||
:ref:`-logRequestResult-` Produces a log entry for every incoming request and ``RouteResult``
|
||||
:ref:`-logResult-` Produces a log entry for every ``RouteResult``
|
||||
:ref:`-mapInnerRoute-` Transforms its inner ``Route`` with a ``Route => Route`` function
|
||||
:ref:`-mapRejections-` Transforms rejections from a previous route with an
|
||||
``immutable.Seq[Rejection] ⇒ immutable.Seq[Rejection]`` function
|
||||
:ref:`-mapRequest-` Transforms the request with an ``HttpRequest => HttpRequest`` function
|
||||
:ref:`-mapRequestContext-` Transforms the ``RequestContext`` with a
|
||||
``RequestContext => RequestContext`` function
|
||||
:ref:`-mapResponse-` Transforms the response with an ``HttpResponse => HttpResponse`` function
|
||||
:ref:`-mapResponseEntity-` Transforms the response entity with an ``ResponseEntity ⇒ ResponseEntity``
|
||||
function
|
||||
:ref:`-mapResponseHeaders-` Transforms the response headers with an
|
||||
``immutable.Seq[HttpHeader] ⇒ immutable.Seq[HttpHeader]`` function
|
||||
:ref:`-mapRouteResult-` Transforms the ``RouteResult`` with a ``RouteResult ⇒ RouteResult``
|
||||
function
|
||||
:ref:`-mapRouteResultFuture-` Transforms the ``RouteResult`` future with a
|
||||
``Future[RouteResult] ⇒ Future[RouteResult]`` function
|
||||
:ref:`-mapRouteResultPF-` Transforms the ``RouteResult`` with a
|
||||
``PartialFunction[RouteResult, RouteResult]``
|
||||
:ref:`-mapRouteResultWith-` Transforms the ``RouteResult`` with a
|
||||
``RouteResult ⇒ Future[RouteResult]`` function
|
||||
:ref:`-mapRouteResultWithPF-` Transforms the ``RouteResult`` with a
|
||||
``PartialFunction[RouteResult, Future[RouteResult]]``
|
||||
:ref:`-mapSettings-` Transforms the ``RoutingSettings`` with a
|
||||
``RoutingSettings ⇒ RoutingSettings`` function
|
||||
:ref:`-mapUnmatchedPath-` Transforms the ``unmatchedPath`` of the ``RequestContext`` using a
|
||||
``Uri.Path ⇒ Uri.Path`` function
|
||||
:ref:`-method-` Rejects all requests whose HTTP method does not match the given one
|
||||
:ref:`-onComplete-` "Unwraps" a ``Future[T]`` and runs the inner route after future completion
|
||||
with the future's value as an extraction of type ``Try[T]``
|
||||
:ref:`-onSuccess-` "Unwraps" a ``Future[T]`` and runs the inner route after future completion
|
||||
with the future's value as an extraction of type ``T``
|
||||
:ref:`-optionalCookie-` Extracts the ``HttpCookiePair`` with the given name as an
|
||||
``Option[HttpCookiePair]``
|
||||
:ref:`-optionalHeaderValue-` Extracts an optional HTTP header value using a given
|
||||
``HttpHeader ⇒ Option[T]`` function
|
||||
:ref:`-optionalHeaderValueByName-` Extracts the value of the first optional HTTP request header with a given
|
||||
name
|
||||
:ref:`-optionalHeaderValueByType-` Extracts the first optional HTTP request header of the given type
|
||||
:ref:`-optionalHeaderValuePF-` Extracts an optional HTTP header value using a given
|
||||
``PartialFunction[HttpHeader, T]``
|
||||
:ref:`-options-` Rejects all non-OPTIONS requests
|
||||
:ref:`-overrideMethodWithParameter-` Changes the request method to the value of the specified query parameter
|
||||
:ref:`-overrideStatusCode-` Overrides the response status code with the given one
|
||||
:ref:`-parameter-` Extracts a query parameter value from the request
|
||||
:ref:`-parameterMap-` Extracts the request's query parameters as a ``Map[String, String]``
|
||||
:ref:`-parameterMultiMap-` Extracts the request's query parameters as a ``Map[String, List[String]]``
|
||||
:ref:`-parameters-` Extracts a number of query parameter values from the request
|
||||
:ref:`-parameterSeq-` Extracts the request's query parameters as a ``Seq[(String, String)]``
|
||||
:ref:`-pass-` Always simply passes the request on to its inner route, i.e. doesn't do
|
||||
anything, neither with the request nor the response
|
||||
:ref:`-patch-` Rejects all non-PATCH requests
|
||||
:ref:`-path-` Applies the given ``PathMatcher`` to the remaining unmatched path after
|
||||
consuming a leading slash
|
||||
:ref:`-pathEnd-` Only passes on the request to its inner route if the request path has been
|
||||
matched completely
|
||||
:ref:`-pathEndOrSingleSlash-` Only passes on the request to its inner route if the request path has been
|
||||
matched completely or only consists of exactly one remaining slash
|
||||
:ref:`-pathPrefix-` Applies the given ``PathMatcher`` to a prefix of the remaining unmatched
|
||||
path after consuming a leading slash
|
||||
:ref:`-pathPrefixTest-` Checks whether the unmatchedPath has a prefix matched by the given
|
||||
``PathMatcher`` after implicitly consuming a leading slash
|
||||
:ref:`-pathSingleSlash-` Only passes on the request to its inner route if the request path
|
||||
consists of exactly one remaining slash
|
||||
:ref:`-pathSuffix-` Applies the given ``PathMatcher`` to a suffix of the remaining unmatched
|
||||
path (Caution: check scaladoc!)
|
||||
:ref:`-pathSuffixTest-` Checks whether the unmatched path has a suffix matched by the given
|
||||
``PathMatcher`` (Caution: check scaladoc!)
|
||||
:ref:`-post-` Rejects all non-POST requests
|
||||
:ref:`-provide-` Injects a given value into a directive
|
||||
:ref:`-put-` Rejects all non-PUT requests
|
||||
:ref:`-rawPathPrefix-` Applies the given matcher directly to a prefix of the unmatched path of the
|
||||
``RequestContext``, without implicitly consuming a leading slash
|
||||
:ref:`-rawPathPrefixTest-` Checks whether the unmatchedPath has a prefix matched by the given
|
||||
``PathMatcher``
|
||||
:ref:`-recoverRejections-` Transforms rejections from a previous route with an
|
||||
``immutable.Seq[Rejection] ⇒ RouteResult`` function
|
||||
:ref:`-recoverRejectionsWith-` Transforms rejections from a previous route with an
|
||||
``immutable.Seq[Rejection] ⇒ Future[RouteResult]`` function
|
||||
:ref:`-redirect-` Completes the request with redirection response of the given type to the
|
||||
given URI
|
||||
:ref:`-redirectToNoTrailingSlashIfPresent-` If the request path ends with a slash, redirects to the same uri without
|
||||
trailing slash in the path
|
||||
:ref:`-redirectToTrailingSlashIfMissing-` If the request path doesn't end with a slash, redirects to the same uri with
|
||||
trailing slash in the path
|
||||
:ref:`-reject-` Rejects the request with the given rejections
|
||||
:ref:`-rejectEmptyResponse-` Converts responses with an empty entity into (empty) rejections
|
||||
:ref:`-requestEncodedWith-` Rejects the request with an ``UnsupportedRequestEncodingRejection`` if its
|
||||
encoding doesn't match the given one
|
||||
:ref:`-requestEntityEmpty-` Rejects if the request entity is non-empty
|
||||
:ref:`-requestEntityPresent-` Rejects with a ``RequestEntityExpectedRejection`` if the request entity is
|
||||
empty
|
||||
:ref:`-respondWithDefaultHeader-` Adds a given response header if the response doesn't already contain a
|
||||
header with the same name
|
||||
:ref:`-respondWithDefaultHeaders-` Adds the subset of the given headers to the response which doesn't already
|
||||
have a header with the respective name present in the response
|
||||
:ref:`-respondWithHeader-` Unconditionally adds a given header to the outgoing response
|
||||
:ref:`-respondWithHeaders-` Unconditionally adds the given headers to the outgoing response
|
||||
:ref:`-responseEncodingAccepted-` Rejects the request with an ``UnacceptedResponseEncodingRejection`` if the
|
||||
given response encoding is not accepted by the client
|
||||
:ref:`-scheme-` Rejects all requests whose URI scheme doesn't match the given one
|
||||
:ref:`-setCookie-` Adds a ``Set-Cookie`` response header with the given cookies
|
||||
:ref:`-textract-` Extracts a number of values using a ``RequestContext ⇒ Tuple`` function
|
||||
:ref:`-tprovide-` Injects a given tuple of values into a directive
|
||||
:ref:`-validate-` Checks a given condition before running its inner route
|
||||
:ref:`-withExecutionContext-` Runs its inner route with the given alternative ``ExecutionContext``
|
||||
:ref:`-withFlowMaterializer-` Runs its inner route with the given alternative ``FlowMaterializer``
|
||||
:ref:`-withLog-` Runs its inner route with the given alternative ``LoggingAdapter``
|
||||
:ref:`-withRangeSupport-` Adds ``Accept-Ranges: bytes`` to responses to GET requests, produces partial
|
||||
responses if the initial request contained a valid ``Range`` header
|
||||
:ref:`-withSettings-` Runs its inner route with the given alternative ``RoutingSettings``
|
||||
=========================================== ============================================================================
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ cancelRejection
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: cancelRejection
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ cancelRejections
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: cancelRejections
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Calculates a value from the request context and provides the value to the inner
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: extract
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ extractExecutionContext
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: extractExecutionContext
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ extractFlowMaterializer
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: extractFlowMaterializer
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ extractLog
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: extractLog
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Extracts the complete ``HttpRequest`` instance.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: extractRequest
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ extractRequestContext
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: extractRequestContext
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ extractSettings
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: extractSettings
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Extracts the unmatched path from the request context.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: extractUnmatchedPath
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Access the full URI of the request.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: extractUri
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Changes the execution model of the inner route by wrapping it with arbitrary log
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: mapInnerRoute
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Transforms the list of rejections the inner route produced.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: mapRejections
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Transforms the request before it is handled by the inner route.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: mapRequest
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Transforms the ``RequestContext`` before it is passed to the inner route.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: mapRequestContext
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Changes the response that was generated by the inner route.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: mapResponse
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Changes the response entity that was generated by the inner route.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: mapResponseEntity
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Changes the list of response headers that was generated by the inner route.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: mapResponseHeaders
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Changes the message the inner route sends to the responder.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: mapRouteResult
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ mapRouteResultFuture
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: mapRouteResultFuture
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Changes the message the inner route sends to the responder.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: mapRouteResultPF
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ mapRouteResultWith
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: mapRouteResultWith
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ mapRouteResultWithPF
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: mapRouteResultWithPF
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ mapSettings
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: mapSettings
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Transforms the unmatchedPath field of the request context for inner routes.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: mapUnmatchedPath
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ A directive that passes the request unchanged to its inner route.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: pass
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Provides a constant value to the inner route.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: provide
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ recoverRejections
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: recoverRejections
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ recoverRejectionsWith
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: recoverRejectionsWith
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Calculates a tuple of values from the request context and provides them to the i
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: textract
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Provides a tuple of values to the inner route.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: tprovide
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ withExecutionContext
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: withExecutionContext
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ withFlowMaterializer
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: withFlowMaterializer
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ withLog
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: withLog
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ withSettings
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
|
||||
:snippet: withSettings
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ by http://tools.ietf.org/html/draft-ietf-httpbis-p4-conditional-26.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/CacheConditionDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/CacheConditionDirectives.scala
|
||||
:snippet: conditional
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ Tries to decode the request with the specified ``Decoder`` or rejects the reques
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/CodingDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/CodingDirectives.scala
|
||||
:snippet: decodeRequest
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ decodeRequestWith
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/CodingDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/CodingDirectives.scala
|
||||
:snippet: decodeRequestWith
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ Tries to encode the response with the specified ``Encoder`` or rejects the reque
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/CodingDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/CodingDirectives.scala
|
||||
:snippet: encodeResponse
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ encodeResponseWith
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/CodingDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/CodingDirectives.scala
|
||||
:snippet: encodeResponseWith
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ rejects the request with an ``UnacceptedRequestEncodingRejection(encoding)``.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/CodingDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/CodingDirectives.scala
|
||||
:snippet: requestEncodedWith
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ rejects the request with an ``UnacceptedResponseEncodingRejection(encoding)``.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/CodingDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/CodingDirectives.scala
|
||||
:snippet: responseEncodingAccepted
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ the cookie is missing.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/CookieDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/CookieDirectives.scala
|
||||
:snippet: cookie
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Adds a header to the response to request the removal of the cookie with the give
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/CookieDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/CookieDirectives.scala
|
||||
:snippet: deleteCookie
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Extracts an optional cookie with a given name from a request.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/CookieDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/CookieDirectives.scala
|
||||
:snippet: optionalCookie
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Adds a header to the response to request the update of the cookie with the given
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/CookieDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/CookieDirectives.scala
|
||||
:snippet: setCookie
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Catches exceptions thrown by the inner route and handles them using the specifie
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/ExecutionDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/ExecutionDirectives.scala
|
||||
:snippet: handleExceptions
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Handles rejections produced by the inner route and handles them using the specif
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/ExecutionDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/ExecutionDirectives.scala
|
||||
:snippet: handleRejections
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ served as browsable listings.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/FileAndResourceDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/FileAndResourceDirectives.scala
|
||||
:snippet: getFromBrowseableDirectories
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,6 +8,6 @@ The single-directory variant of :ref:`-getFromBrowseableDirectories-`.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/FileAndResourceDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/FileAndResourceDirectives.scala
|
||||
:snippet: getFromBrowseableDirectory
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Completes GET requests with the content of a file underneath the given directory
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/FileAndResourceDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/FileAndResourceDirectives.scala
|
||||
:snippet: getFromDirectory
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Completes GET requests with the content of the given file.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/FileAndResourceDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/FileAndResourceDirectives.scala
|
||||
:snippet: getFromFile
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Completes GET requests with the content of the given classpath resource.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/FileAndResourceDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/FileAndResourceDirectives.scala
|
||||
:snippet: getFromResource
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Completes GET requests with the content of the given classpath resource director
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/FileAndResourceDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/FileAndResourceDirectives.scala
|
||||
:snippet: getFromResourceDirectory
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ directory contents is performed by the in-scope `Marshaller[DirectoryListing]`.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/FileAndResourceDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/FileAndResourceDirectives.scala
|
||||
:snippet: listDirectoryContents
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ An alias for :ref:`-formFields-`.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/FormFieldDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/FormFieldDirectives.scala
|
||||
:snippet: formField
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ as required, optional, or repeated, or to filter requests where a form field has
|
|||
extract multiple occurrences of field "distance" as ``Iterable[String]``
|
||||
``"distance".as[Int].*``
|
||||
extract multiple occurrences of field "distance" as ``Iterable[Int]``, you need a matching implicit ``Deserializer`` in scope for that to work
|
||||
(see also :ref:`unmarshalling`)
|
||||
(see also :ref:`http-unmarshalling-scala`)
|
||||
``"distance".as(deserializer).*``
|
||||
extract multiple occurrences of field "distance" with an explicit ``Deserializer``
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ with the implicitly given ``ToResponseMarshaller[T]``. Runs the inner route if t
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/FutureDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/FutureDirectives.scala
|
||||
:snippet: completeOrRecoverWith
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ result as a value of type ``Try[T]`` and passes it to the inner route.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/FutureDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/FutureDirectives.scala
|
||||
:snippet: onComplete
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ extracts its result as a value of type ``T`` and passes it to the inner route.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/FutureDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/FutureDirectives.scala
|
||||
:snippet: onSuccess
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ Traverses the list of request headers with the specified function and extracts t
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/HeaderDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/HeaderDirectives.scala
|
||||
:snippet: headerValue
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Extracts the value of the HTTP request header with the given name.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/HeaderDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/HeaderDirectives.scala
|
||||
:snippet: headerValueByName
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ result of calling the function.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/HeaderDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/HeaderDirectives.scala
|
||||
:snippet: headerValuePF
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ Traverses the list of request headers with the specified function and extracts t
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/HeaderDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/HeaderDirectives.scala
|
||||
:snippet: optionalHeaderValue
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Optionally extracts the value of the HTTP request header with the given name.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/HeaderDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/HeaderDirectives.scala
|
||||
:snippet: optionalHeaderValueByName
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ result of calling the function.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/HeaderDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/HeaderDirectives.scala
|
||||
:snippet: optionalHeaderValuePF
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ Extracts the hostname part of the Host header value in the request.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/HostDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/HostDirectives.scala
|
||||
:snippet: extractHost
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ in the request.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/HostDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/HostDirectives.scala
|
||||
:snippet: host
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ inner route. You can use it to decouple marshaller resolution from request comp
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/MarshallingDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/MarshallingDirectives.scala
|
||||
:snippet: completeWith[T]
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ The ``entity`` method will either pass the ``value`` to the inner route or map t
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/MarshallingDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/MarshallingDirectives.scala
|
||||
:snippet: entity
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ the in-scope marshaller. ``handleWith`` can be a convenient method combining ``
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/MarshallingDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/MarshallingDirectives.scala
|
||||
:snippet: handleWith
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Matches requests with HTTP method ``DELETE``.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
:snippet: delete
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ extractMethod
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
:snippet: extractMethod
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Matches requests with HTTP method ``GET``.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
:snippet: get
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Matches requests with HTTP method ``HEAD``.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
:snippet: head
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Matches HTTP requests based on their method.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
:snippet: method
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Matches requests with HTTP method ``OPTIONS``.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
:snippet: options
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ overrideMethodWithParameter
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
:snippet: overrideMethodWithParameter
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Matches requests with HTTP method ``PATCH``.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
:snippet: patch
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Matches requests with HTTP method ``POST``.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
:snippet: post
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Matches requests with HTTP method ``PUT``.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/MethodDirectives.scala
|
||||
:snippet: put
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ Provides the value of ``X-Forwarded-For``, ``Remote-Address``, or ``X-Real-IP``
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/MiscDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/MiscDirectives.scala
|
||||
:snippet: extractClientIP
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Replaces a response with no content with an empty rejection.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/MiscDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/MiscDirectives.scala
|
||||
:snippet: rejectEmptyResponse
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ Otherwise, the request is rejected.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/MiscDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/MiscDirectives.scala
|
||||
:snippet: requestEntityEmpty
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ Otherwise, the request is rejected.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/MiscDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/MiscDirectives.scala
|
||||
:snippet: requestEntityPresent
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ request with a ``ValidationRejection`` containing the given error message.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/MiscDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/MiscDirectives.scala
|
||||
:snippet: validate
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ An alias for :ref:`-parameters-`.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/ParameterDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/ParameterDirectives.scala
|
||||
:snippet: parameter
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ parameter values.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/ParameterDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/ParameterDirectives.scala
|
||||
:snippet: parameterMap
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ a parameter name to a list of all its values.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/ParameterDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/ParameterDirectives.scala
|
||||
:snippet: parameterMultiMap
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Extracts all parameters at once in the original order as (name, value) tuples of
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/ParameterDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/ParameterDirectives.scala
|
||||
:snippet: parameterSeq
|
||||
|
||||
Description
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ as required, optional, or repeated, or to filter requests where a parameter has
|
|||
extract multiple occurrences of parameter "distance" as ``Iterable[String]``
|
||||
``"distance".as[Int].*``
|
||||
extract multiple occurrences of parameter "distance" as ``Iterable[Int]``, you need a matching ``Deserializer`` in scope for that to work
|
||||
(see also :ref:`unmarshalling`)
|
||||
(see also :ref:`http-unmarshalling-scala`)
|
||||
``"distance".as(deserializer).*``
|
||||
extract multiple occurrences of parameter "distance" with an explicit ``Deserializer``
|
||||
|
||||
|
|
@ -89,13 +89,13 @@ Deserialized parameter
|
|||
:snippet: mapped-value
|
||||
|
||||
Repeated parameter
|
||||
+++++++++++++++++++++++++++++
|
||||
++++++++++++++++++
|
||||
|
||||
... includecode2:: ../../../../code/docs/http/scaladsl/server/directives/ParameterDirectivesExamplesSpec.scala
|
||||
:snippet: repeated
|
||||
|
||||
Repeated, deserialized parameter
|
||||
++++++++++++++++++++++
|
||||
++++++++++++++++++++++++++++++++
|
||||
|
||||
... includecode2:: ../../../../code/docs/http/scaladsl/server/directives/ParameterDirectivesExamplesSpec.scala
|
||||
:snippet: mapped-repeated
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ one or more values (depending on the type of the argument).
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/PathDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/PathDirectives.scala
|
||||
:snippet: path
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ path has been fully matched by a higher-level :ref:`-path-` or :ref:`-pathPrefix
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/PathDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/PathDirectives.scala
|
||||
:snippet: pathEnd
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ or contains only one single slash.
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/PathDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/PathDirectives.scala
|
||||
:snippet: pathEndOrSingleSlash
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ potentially extracts one or more values (depending on the type of the argument).
|
|||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/PathDirectives.scala
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/PathDirectives.scala
|
||||
:snippet: pathPrefix
|
||||
|
||||
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue