Akka HTTPでWeb APIに仕立てる

リスト1：ビルドファイルbuild.sbtの例

libraryDependencies ++= Seq(
  "com.typesafe.akka" %% "akka-http"   % "10.1.5"
  )

リスト2：/pingへのGETリクエストに対するふるまい

val route: Route =
  path("ping") {
    get {
      // ここにふるまいを定義する
      log.info("receive GET request /ping")
      // ...

      // HTTP OKでレスポンスを返す
      complete(HttpEntity(ContentTypes.text/html(UTF-8), "<h1>pong</h1>"))
    }
  }

リスト3：HTTPサーバーの起動

// ルートの定義
object CafeServer extends App {
  val route: Route = ???

  // RunnableGraphの実行(run)にActorMaterializerが必要
  implicit val system = ActorSystem("CafeServer", ConfigFactory.load("cafe"))
  implicit val materializer = ActorMaterializer()

  // HTTPサーバーの起動
  val bindingFuture = Http().bindAndHandle(route, "localhost", 8080)
  bindingFuture
    .map { serverBinding =>
      log.info(s"Server online at ${serverBinding.localAddress}")
      log.info("Press RETURN to stop...")

      // RETURN が押されるまでサーバーを起動したままにする
      StdIn.readLine()

      serverBinding.unbind()
      serverBinding
    }
    .onComplete { _ ⇒
      system.terminate()
      log.info("System terminated.")
    }
  //...

リスト4：サーバーの起動

sbt run

リスト5：HTTPリクエストの送信

http GET http://localhost:8080/ping

リスト6：実行結果

> http GET http://localhost:8080/ping
HTTP/1.1 200 OK
Content-Length: 13
Content-Type: text/html; charset=UTF-8
Date: Mon, 10 Sep 2018 08:11:55 GMT
Server: akka-http/10.1.5

<h1>pong</h1>

リスト7：Route型の定義

type Route = RequestContext => Future[RouteResult]

リスト8：リクエストの拒否

val route: Route =
  path("ping-reject") {
    // ここにふるまいを定義する
    log.info("receive GET request /ping-reject")
    // ...

    reject(AuthorizationFailedRejection)
  }

リスト9：例外をスロー

val route: Route =
  path("ping-fail") {
    // ここにふるまいを定義する
    log.info("receive GET request /ping-fail")
    // ...

    failWith(new IllegalArgumentException("oops!"))
  }

リスト10：リクエストのリダイレクト

val route: Route =
  path("ping-redirect") {
    // ここにふるまいを定義する
    log.info("receive GET request /ping-redirect")
    // ...

    redirect("/ping", StatusCodes.PermanentRedirect)
  }

リスト11：build.sbtにspray-jsonへの依存関係を追加

libraryDependencies ++= Seq(
  "com.typesafe.akka" %% "akka-http-spray-json" % "10.1.5"
  )

リスト12：マーシャラーの定義

import akka.http.scaladsl.marshallers.sprayjson.SprayJsonSupport
import spray.json.DefaultJsonProtocol._

object CafeServer extends App with SprayJsonSupport {

  case class Order(product: String, count: Int)
  implicit val orderFormat = jsonFormat2(Order)
  // ...

リスト13：JSON形式のリクエストとレスポンス

val route: Route =
  path("order") {
    get {
      // ここにふるまいを定義する
      log.info("received GET request /order")
      // ...

      // Order型を返す
      complete(Order("Coffee", 10))
    } ~
    put {
      // Order型で受け取る
      entity(as[Order]) { order =>
        // ここにふるまいを定義する
        log.info("received PUT request /order")
        // ...

        complete(s"Received order: ${order.product} * ${order.count}")
      }
    }
  }

リスト14：PUTリクエストを送信した結果

> http PUT http://localhost:8080/order product=Coffee, count:=10
HTTP/1.1 200 OK
Content-Length: 27
Content-Type: text/plain; charset=UTF-8
Date: Mon, 10 Sep 2018 08:13:29 GMT
Server: akka-http/10.1.5

Received order: Coffee * 10

リスト15：GETリクエストを送信した結果

> http GET http://localhost:8080/order
HTTP/1.1 200 OK
Content-Length: 31
Content-Type: application/json
Date: Mon, 10 Sep 2018 08:14:05 GMT
Server: akka-http/10.1.5

{
    "count": 10,
    "product": "Coffee"
}