+doc #20466 example snippet for akka http java dsl: BasicDirectives (#20647)

2016-06-03 19:43:42 +08:00 · 2016-06-03 19:43:42 +08:00 · f98c1946d8
commit f98c1946d8
parent 5afb68cd59
38 changed files with 914 additions and 52 deletions
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/cancelRejection.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/cancelRejection.rst
@ -16,4 +16,5 @@ which provides a nicer DSL for building rejection handlers.

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#cancelRejection
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/cancelRejections.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/cancelRejections.rst
@ -18,4 +18,5 @@ which provides a nicer DSL for building rejection handlers.

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#cancelRejections
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/extract.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/extract.rst
@ -13,4 +13,5 @@ See :ref:`ProvideDirectives-java` for an overview of similar directives.

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#extract
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/extractExecutionContext.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/extractExecutionContext.rst
@ -14,4 +14,5 @@ See :ref:`-extract-java-` to learn more about how extractions work.

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#extractExecutionContext
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/extractLog.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/extractLog.rst
@ -15,4 +15,5 @@ See :ref:`-extract-java-` and :ref:`ProvideDirectives-java` for an overview of s

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#extractLog
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/extractMaterializer.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/extractMaterializer.rst
@ -13,4 +13,5 @@ See also :ref:`-withMaterializer-java-` to see how to customise the used materia

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#extractMaterializer
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/extractRequest.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/extractRequest.rst
@ -13,4 +13,5 @@ directives. See :ref:`Request Directives-java`.

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#extractRequest
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/extractRequestContext.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/extractRequestContext.rst
@ -16,4 +16,5 @@ See also :ref:`-extractRequest-java-` if only interested in the :class:`HttpRequ

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#extractRequestContext
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/extractSettings.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/extractSettings.rst
@ -13,4 +13,5 @@ It is possible to override the settings for specific sub-routes by using the :re

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#extractRequestContext
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/extractUnmatchedPath.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/extractUnmatchedPath.rst
@ -15,4 +15,5 @@ Use ``mapUnmatchedPath`` to change the value of the unmatched path.

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#extractUnmatchedPath
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/extractUri.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/extractUri.rst
@ -12,4 +12,5 @@ targeted access to parts of the URI.

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#extractUri
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapInnerRoute.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapInnerRoute.rst
@ -12,4 +12,5 @@ with any other route. Usually, the returned route wraps the original one with cu

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#mapInnerRoute
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapRejections.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapRejections.rst
@ -16,4 +16,5 @@ See :ref:`Response Transforming Directives-java` for similar directives.

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#mapRejections
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapRequest.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapRequest.rst
@ -16,4 +16,5 @@ See :ref:`Request Transforming Directives-java` for an overview of similar direc

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#mapRequest
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapRequestContext.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapRequestContext.rst
@ -15,4 +15,5 @@ See :ref:`Request Transforming Directives-java` for an overview of similar direc

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#mapRequestContext
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapResponse.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapResponse.rst
@ -14,8 +14,10 @@ See also :ref:`-mapResponseHeaders-java-` or :ref:`-mapResponseEntity-java-` for

 Example: Override status
 ------------------------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#mapResponse

 Example: Default to empty JSON response on errors
 -------------------------------------------------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#mapResponse-advanced
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapResponseEntity.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapResponseEntity.rst
@ -13,4 +13,5 @@ See :ref:`Response Transforming Directives-java` for similar directives.

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#mapResponseEntity
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapResponseHeaders.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapResponseHeaders.rst
@ -14,4 +14,5 @@ See :ref:`Response Transforming Directives-java` for similar directives.

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#mapResponseHeaders
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapRouteResult.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapRouteResult.rst
@ -14,4 +14,5 @@ See :ref:`Result Transformation Directives-java` for similar directives.

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#mapRouteResult
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapRouteResultFuture.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapRouteResultFuture.rst
@ -17,4 +17,5 @@ See :ref:`Result Transformation Directives-java` for similar directives.

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#mapRouteResultFuture
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapRouteResultPF.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapRouteResultPF.rst
@ -17,4 +17,6 @@ See :ref:`Result Transformation Directives-java` for similar directives.

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#mapRouteResultPF
+
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapRouteResultWith.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapRouteResultWith.rst
@ -16,4 +16,5 @@ See :ref:`Result Transformation Directives-java` for similar directives.

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#mapRouteResultWith
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapRouteResultWithPF.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapRouteResultWithPF.rst
@ -17,4 +17,5 @@ See :ref:`Result Transformation Directives-java` for similar directives.

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#mapRouteResultWithPF
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapSettings.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapSettings.rst
@ -12,4 +12,5 @@ See also :ref:`-withSettings-java-` or :ref:`-extractSettings-java-`.

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#mapSettings
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapUnmatchedPath.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/mapUnmatchedPath.rst
@ -14,4 +14,5 @@ Use ``extractUnmatchedPath`` for extracting the current value of the unmatched p

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#mapUnmatchedPath
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/pass.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/pass.rst
@ -11,4 +11,5 @@ It is usually used as a "neutral element" when combining directives generically.

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#pass
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/provide.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/provide.rst
@ -13,4 +13,5 @@ See :ref:`ProvideDirectives-java` for an overview of similar directives.

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#provide
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/recoverRejections.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/recoverRejections.rst
@ -17,4 +17,5 @@ rejections.

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#recoverRejections
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/recoverRejectionsWith.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/recoverRejectionsWith.rst
@ -20,4 +20,5 @@ See :ref:`-recoverRejections-java-` (the synchronous equivalent of this directiv

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#recoverRejectionsWith
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/withExecutionContext.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/withExecutionContext.rst
@ -14,4 +14,5 @@ or used by directives which internally extract the materializer without sufracin

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#withExecutionContext
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/withLog.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/withLog.rst
@ -14,4 +14,5 @@ or used by directives which internally extract the materializer without surfacin

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#withLog
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/withMaterializer.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/withMaterializer.rst
@ -14,4 +14,5 @@ or used by directives which internally extract the materializer without sufracin

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#withMaterializer
--- a/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/withSettings.rst
+++ b/akka-docs/rst/java/http/routing-dsl/directives/basic-directives/withSettings.rst
@ -13,4 +13,6 @@ or used by directives which internally extract the materializer without sufracin

 Example
 -------
-TODO: Example snippets for JavaDSL are subject to community contributions! Help us complete the docs, read more about it here: `write example snippets for Akka HTTP Java DSL #20466 <https://github.com/akka/akka/issues/20466>`_.
+
+.. includecode:: ../../../../code/docs/http/javadsl/server/directives/BasicDirectivesExamplesTest.java#withSettings
+