Packages

  • package root

    This is the API documentation for finch

    This is the API documentation for finch

    Finch is a thin layer of purely functional basic blocks atop of [Finagle][finagle] for building composable HTTP APIs. Its mission is to provide the developers simple and robust HTTP primitives being as close as possible to the bare metal Finagle API.

    Finch uses multi-project structure and contains of the following _modules_:

    • core - the core classes/functions
    • argonaut - the JSON API support for the [Argonaut][argonaut] library
    • jackson - the JSON API support for the [Jackson][jackson] library
    • json4s - the JSON API support for the [JSON4S][json4s] library
    • circe - the JSON API support for the [Circe][circe] library
    • playjson - The JSON API support for the [PlayJson][playjson] library
    • sprayjson - The JSON API support for the [SprayJson][sprayjson] library
    • test - the test support classes/functions
    • oauth2 - the OAuth2 support backed by the [finagle-oauth2][finagle-oauth2] library
    • see - SSE ([Server Sent Events][server-sent-events]) support in Finch

    Please refer to the documentation for a more detailed introduction to the library.

    Definition Classes
    root
  • package io
    Definition Classes
    root
  • package finch

    This is a root package of the Finch library, which provides an immutable layer of functions and types atop of Finagle for writing lightweight HTTP services.

    This is a root package of the Finch library, which provides an immutable layer of functions and types atop of Finagle for writing lightweight HTTP services.

    Definition Classes
    io
  • package argonaut
    Definition Classes
    finch
  • package circe
    Definition Classes
    finch
  • package div
    Definition Classes
    finch
  • package generic
    Definition Classes
    finch
  • package internal

    This package contains an internal-use only type-classes and utilities that power Finch's API.

    This package contains an internal-use only type-classes and utilities that power Finch's API.

    It's not recommended to use any of the internal API directly, since it might change without any deprecation cycles.

    Definition Classes
    finch
  • package iteratee

    Iteratee module

    Iteratee module

    Definition Classes
    finch
  • package refined
    Definition Classes
    finch
  • package sse
    Definition Classes
    finch
  • package streaming
    Definition Classes
    finch
  • package syntax

    Enables Sinatra-like syntax extensions for endpoints.

    Enables Sinatra-like syntax extensions for endpoints.

    Definition Classes
    finch
  • package test
    Definition Classes
    finch
  • package todo
    Definition Classes
    finch
  • Main
  • Todo
  • TodoNotFound
  • package wrk
    Definition Classes
    finch
p

io.finch

todo

package todo

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. case class Todo(id: UUID, title: String, completed: Boolean, order: Int) extends Product with Serializable
  2. case class TodoNotFound(id: UUID) extends Exception with Product with Serializable

Value Members

  1. object Main extends TwitterServer

    A simple Finch application implementing the backend for the TodoMVC project.

    A simple Finch application implementing the backend for the TodoMVC project.

    Use the following sbt command to run the application.

    $ sbt 'examples/runMain io.finch.todo.Main'

    Use the following HTTPie commands to test endpoints.

    $ http POST :8081/todos title=foo order:=0 completed:=false
    $ http PATCH :8081/todos/<UUID> completed:=true
    $ http :8081/todos
    $ http DELETE :8081/todos/<UUID>
    $ http DELETE :8081/todos
  2. object Todo extends Serializable

Ungrouped