Add HTTP custom method example to doc (akka#954)

richardimaoka · Mar 29, 2017 · a278c99 · a278c99
1 parent 877f77f
commit a278c99
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 1 deletion.
diff --git a/docs/src/main/paradox/java/http/common/http-model.md b/docs/src/main/paradox/java/http/common/http-model.md
@@ -346,6 +346,14 @@ Similarily to the media types registration, you can register custom status codes
 
 @@snip [CustomStatusCodesExampleTest.java](../../../../../test/java/docs/http/javadsl/CustomStatusCodesExampleTest.java) { #application-custom-java }
 
+<a id="registeringcustommethod"></a>
+## Registering Custom HTTP Method
+
+Akka HTTP also allows you to define custome HTTP methods, other than the well-known methods @javadoc[predefined](akka.http.javadsl.model.HttpMethods) in Akka HTTP.
+To use a custom HTTP method, you need to define it, and then add it to parser settings like below:
+
+@@snip [CustomHttpMethodsExampleTest.java](../../../../../test/java/docs/http/javadsl/server/directives/CustomHttpMethodExamplesTest.java) { #customHttpMethod }
+
 ## The URI model
 
 Akka HTTP offers its own specialised URI model class which is tuned for both performance and idiomatic usage within

diff --git a/docs/src/main/paradox/scala/http/common/http-model.md b/docs/src/main/paradox/scala/http/common/http-model.md
@@ -359,6 +359,14 @@ Similarily to the media types registration, you can register custom status codes
 
 @@snip [CustomStatusCodesSpec.scala](../../../../../../../akka-http-tests/src/test/scala/akka/http/scaladsl/CustomStatusCodesSpec.scala) { #application-custom }
 
+<a id="registeringcustommethod"></a>
+## Registering Custom HTTP Method
+
+Akka HTTP also allows you to define custome HTTP methods, other than the well-known methods @scaladoc[predefined](akka.http.scaladsl.model.HttpMethods$) in Akka HTTP.
+To use a custom HTTP method, you need to define it, and then add it to parser settings like below:
+
+@@snip [CustomHttpMethodSpec.scala](../../../../../test/scala/docs/http/scaladsl/server/directives/CustomHttpMethodSpec.scala) { #application-custom }
+
 ## The URI model
 
 Akka HTTP offers its own specialised URI model class which is tuned for both performance and idiomatic usage within

diff --git a/docs/src/test/java/docs/http/javadsl/server/directives/CustomHttpMethodExamplesTest.java b/docs/src/test/java/docs/http/javadsl/server/directives/CustomHttpMethodExamplesTest.java
@@ -38,8 +38,12 @@ public void testComposition() throws InterruptedException, ExecutionException {
     String host = "127.0.0.1";
 
     //#customHttpMethod
+
+    // define custom method type:
     HttpMethod BOLT =
       HttpMethods.createCustom("BOLT", false, true, Expected);
+
+    // add custom method to parser settings:
     final ParserSettings parserSettings =
       ParserSettings.create(system).withCustomMethods(BOLT);
     final ServerSettings serverSettings =

diff --git a/docs/src/test/scala/docs/http/scaladsl/server/directives/CustomHttpMethodSpec.scala b/docs/src/test/scala/docs/http/scaladsl/server/directives/CustomHttpMethodSpec.scala
@@ -30,7 +30,7 @@ class CustomHttpMethodSpec extends AkkaSpec with ScalaFutures
       //#application-custom
       import akka.http.scaladsl.settings.{ ParserSettings, ServerSettings }
 
-      // define custom media type:
+      // define custom method type:
       val BOLT = HttpMethod.custom("BOLT", safe = false,
         idempotent = true, requestEntityAcceptance = Expected)