!htp akka#953 Rename HttpApp.route to routes (akka#1070)

Fixes akka#953.

akka-http-tests/src/test/java/akka/http/javadsl/server/MinimalHttpApp.java

@@ -18,7 +18,7 @@ public class MinimalHttpApp extends HttpApp {
   CompletableFuture<Done> bindingPromise = new CompletableFuture<>();
 
   @Override
-  protected Route route() {
+  protected Route routes() {
     return route(path("foo", () ->
         complete("bar")
       ),

akka-http-tests/src/test/scala/akka/http/scaladsl/server/HttpAppSpec.scala

@@ -31,7 +31,7 @@ class HttpAppSpec extends AkkaSpec with RequestBuilding with Eventually {
     val shutdownPromise = Promise[Done]()
     val bindingPromise = Promise[Done]()
 
-    override protected def route: Route =
+    override protected def routes: Route =
       path("foo") {
         complete("bar")
       } ~

akka-http/src/main/java/akka/http/javadsl/server/HttpApp.java

@@ -73,7 +73,7 @@ public void startServer(String host, int port, ServerSettings settings, Optional
 
     CompletionStage<ServerBinding> bindingFuture = Http
       .get(theSystem)
-      .bindAndHandle(route().flow(theSystem, materializer),
+      .bindAndHandle(routes().flow(theSystem, materializer),
         ConnectHttp.toHost(host, port),
         settings,
         theSystem.log(),
@@ -162,7 +162,6 @@ protected CompletionStage<Done> waitForShutdownSignal (ActorSystem system) {
   /**
    * Override to implement the route that will be served by this http server.
    */
-  protected abstract Route route();
-
+  protected abstract Route routes();
 
 }

akka-http/src/main/mima-filters/10.0.6.backwards.excludes

@@ -0,0 +1,4 @@
+# Provide routes method in HttpApp #953 Rename of method is OK as class is `@ApiMayChange`
+ProblemFilters.exclude[ReversedMissingMethodProblem]("akka.http.javadsl.server.HttpApp.routes")
+ProblemFilters.exclude[ReversedMissingMethodProblem]("akka.http.scaladsl.server.HttpApp.routes")
+ProblemFilters.exclude[DirectMissingMethodProblem]("akka.http.scaladsl.server.HttpApp.route")

akka-http/src/main/scala/akka/http/scaladsl/server/HttpApp.scala

@@ -70,7 +70,7 @@ abstract class HttpApp extends Directives {
     implicit val executionContext = theSystem.dispatcher
 
     val bindingFuture = Http().bindAndHandle(
-      handler = route,
+      handler = routes,
       interface = host,
       port = port,
       settings = settings)
@@ -146,8 +146,7 @@ abstract class HttpApp extends Directives {
   }
 
   /**
-   * Override to implement the route that will be served by this http server.
+   * Override to implement the routes that will be served by this http server.
    */
-  protected def route: Route
-
+  protected def routes: Route
 }

docs/src/main/paradox/java/http/migration-guide/index.md

@@ -7,5 +7,6 @@
 
 * [migration-from-old-http-javadsl](migration-from-old-http-javadsl.md)
 * [migration-guide-2.4.x-10.0.x](migration-guide-2.4.x-10.0.x.md)
+* [migration-within-10.0.x-Api-May-Change](migration-within-10.0.x-Api-May-Change.md)
 
 @@@

docs/src/main/paradox/java/http/migration-guide/migration-within-10.0.x-Api-May-Change.md

@@ -0,0 +1,18 @@
+# Migration Guide within Akka HTTP 10.0.x
+
+## General Notes
+Akka HTTP is binary backwards compatible within for all version within the 10.0.x range. However, there are a set of APIs
+that are marked with the special annotation `@ApiMayChange` which are exempt from this rule, in order to allow them to be 
+evolved more freely until stabilising them, by removing this annotation.
+See @extref:[The @DoNotInherit and @ApiMayChange markers](akka-docs:common/binary-compatibility-rules.html#The_@DoNotInherit_and_@ApiMayChange_markers) for further information.
+
+This migration guide aims to help developers who use these bleeding-edge APIs to migrate between their evolving versions
+within patch releases.
+
+## Akka HTTP 10.0.6 -> 10.0.7
+
+### `AkkaHttp#route` has been renamed to `AkkaHttp#routes`
+
+In order to provide a more descriptive name, `AkkaHttp#route` has been renamed to `AkkaHttp#routes`. The previous name
+might have led to some confusion by wrongly implying that only one route could be returned in that method.
+To migrate to 10.0.6, you must rename the old `route` method to `routes`.

docs/src/main/paradox/java/http/routing-dsl/HttpApp.md

@@ -12,7 +12,7 @@ in the Akka documentation.
 ## Introduction
 
 The objective of `HttpApp` is to help you start an HTTP server with just a few lines of code.
-This is accomplished just by extending `HttpApp` and implementing the `route()` method.
+This is accomplished just by extending `HttpApp` and implementing the `routes()` method.
 If desired, `HttpApp` provides different hook methods that can be overridden to change its default behavior.
 
 ## Minimal Example

docs/src/main/paradox/scala/http/migration-guide/index.md

@@ -7,5 +7,6 @@
 
 * [migration-from-spray](migration-from-spray.md)
 * [migration-guide-2.4.x-10.0.x](migration-guide-2.4.x-10.0.x.md)
+* [migration-within-10.0.x-Api-May-Change](migration-within-10.0.x-Api-May-Change.md)
 
 @@@

docs/src/main/paradox/scala/http/migration-guide/migration-within-10.0.x-Api-May-Change.md

@@ -0,0 +1,18 @@
+# Migration Guide within Akka HTTP 10.0.x
+
+## General Notes
+Akka HTTP is binary backwards compatible within for all version within the 10.0.x range. However, there are a set of APIs
+that are marked with the special annotation `@ApiMayChange` which are exempt from this rule, in order to allow them to be 
+evolved more freely until stabilising them, by removing this annotation.
+See @extref:[The @DoNotInherit and @ApiMayChange markers](akka-docs:common/binary-compatibility-rules.html#The_@DoNotInherit_and_@ApiMayChange_markers) for further information.
+
+This migration guide aims to help developers who use these bleeding-edge APIs to migrate between their evolving versions
+within patch releases.
+
+## Akka HTTP 10.0.6 -> 10.0.7
+
+### `AkkaHttp#route` has been renamed to `AkkaHttp#routes`
+
+In order to provide a more descriptive name, `AkkaHttp#route` has been renamed to `AkkaHttp#routes`. The previous name
+might have led to some confusion by wrongly implying that only one route could be returned in that method.
+To migrate to 10.0.6, you must rename the old `route` method to `routes`.

docs/src/main/paradox/scala/http/routing-dsl/HttpApp.md

@@ -12,7 +12,7 @@ in the Akka documentation.
 ## Introduction
 
 The objective of `HttpApp` is to help you start an HTTP server with just a few lines of code.
-This is accomplished just by extending `HttpApp` and implementing the `route()` method.
+This is accomplished just by extending `HttpApp` and implementing the `routes()` method.
 If desired, `HttpApp` provides different hook methods that can be overridden to change its default behavior.
 
 ## Minimal Example

docs/src/test/java/docs/http/javadsl/server/HttpAppExampleTest.java

@@ -43,7 +43,7 @@ public void compileOnlySpec() throws Exception {
     // Server definition
     class MinimalHttpApp extends HttpApp {
       @Override
-      protected Route route() {
+      protected Route routes() {
         return path("hello", () ->
           get(() ->
             complete("<h1>Say hello to akka-http</h1>")
@@ -79,7 +79,7 @@ void withSettingsServer() throws ExecutionException, InterruptedException {
     class SelfDestroyingHttpApp extends HttpApp {
 
       @Override
-      protected Route route() {
+      protected Route routes() {
         return path("hello", () ->
           get(() ->
               complete("<h1>Say hello to akka-http</h1>")
@@ -114,7 +114,7 @@ void selfDestroyingServer() throws ExecutionException, InterruptedException {
     class FailBindingOverrideHttpApp extends HttpApp {
 
       @Override
-      protected Route route() {
+      protected Route routes() {
         return path("hello", () ->
           get(() ->
             complete("<h1>Say hello to akka-http</h1>")
@@ -157,7 +157,7 @@ void ownActorSystem() throws ExecutionException, InterruptedException {
     class PostShutdownOverrideHttpApp extends HttpApp {
 
       @Override
-      protected Route route() {
+      protected Route routes() {
         return path("hello", () ->
           get(() ->
             complete("<h1>Say hello to akka-http</h1>")

docs/src/test/scala/docs/http/scaladsl/HttpAppExampleSpec.scala

@@ -17,7 +17,7 @@ class HttpAppExampleSpec extends WordSpec with Matchers
 
     // Server definition
     object WebServer extends HttpApp {
-      def route: Route =
+      override def routes: Route =
         path("hello") {
           get {
             complete(HttpEntity(ContentTypes.`text/html(UTF-8)`, "<h1>Say hello to akka-http</h1>"))
@@ -40,7 +40,7 @@ class HttpAppExampleSpec extends WordSpec with Matchers
 
     // Server definition
     object WebServer extends HttpApp {
-      def route: Route =
+      override def routes: Route =
         path("hello") {
           get {
             complete(HttpEntity(ContentTypes.`text/html(UTF-8)`, "<h1>Say hello to akka-http</h1>"))
@@ -63,7 +63,7 @@ class HttpAppExampleSpec extends WordSpec with Matchers
 
     // Server definition
     object WebServer extends HttpApp {
-      def route: Route =
+      override def routes: Route =
         path("hello") {
           get {
             complete(HttpEntity(ContentTypes.`text/html(UTF-8)`, "<h1>Say hello to akka-http</h1>"))
@@ -96,7 +96,7 @@ class HttpAppExampleSpec extends WordSpec with Matchers
 
     // Server definition
     object WebServer extends HttpApp {
-      def route: Route =
+      override def routes: Route =
         path("hello") {
           get {
             complete(HttpEntity(ContentTypes.`text/html(UTF-8)`, "<h1>Say hello to akka-http</h1>"))
@@ -123,7 +123,7 @@ class HttpAppExampleSpec extends WordSpec with Matchers
 
     // Server definition
     object WebServer extends HttpApp {
-      def route: Route =
+      override def routes: Route =
         path("hello") {
           get {
             complete(HttpEntity(ContentTypes.`text/html(UTF-8)`, "<h1>Say hello to akka-http</h1>"))
@@ -151,7 +151,7 @@ class HttpAppExampleSpec extends WordSpec with Matchers
 
     // Server definition
     class WebServer extends HttpApp {
-      def route: Route =
+      override def routes: Route =
         path("hello") {
           get {
             complete(HttpEntity(ContentTypes.`text/html(UTF-8)`, "<h1>Say hello to akka-http</h1>"))