{"id":13547407,"url":"https://github.com/finagle/finch","last_synced_at":"2025-04-29T14:40:06.502Z","repository":{"id":16054695,"uuid":"18798826","full_name":"finagle/finch","owner":"finagle","description":"Scala combinator library for building Finagle HTTP services","archived":false,"fork":false,"pushed_at":"2025-04-20T16:47:43.000Z","size":9195,"stargazers_count":1603,"open_issues_count":45,"forks_count":221,"subscribers_count":59,"default_branch":"master","last_synced_at":"2025-04-21T18:01:12.346Z","etag":null,"topics":["circe","finagle","finch","http","json","rest","scala","web"],"latest_commit_sha":null,"homepage":"https://finagle.github.io/finch","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/finagle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2014-04-15T12:17:44.000Z","updated_at":"2025-04-20T16:47:47.000Z","dependencies_parsed_at":"2024-04-01T10:25:42.509Z","dependency_job_id":"7e62256e-a6e2-41c3-b08c-4fa63039d6d9","html_url":"https://github.com/finagle/finch","commit_stats":null,"previous_names":[],"tags_count":62,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finagle%2Ffinch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finagle%2Ffinch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finagle%2Ffinch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finagle%2Ffinch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/finagle","download_url":"https://codeload.github.com/finagle/finch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251520555,"owners_count":21602533,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["circe","finagle","finch","http","json","rest","scala","web"],"created_at":"2024-08-01T12:00:55.182Z","updated_at":"2025-04-29T14:40:06.486Z","avatar_url":"https://github.com/finagle.png","language":"Scala","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/finagle/finch/master/finch-logo.png\" width=\"500px\" /\u003e\n\u003c/p\u003e\n\nFinch is a thin layer of purely functional basic blocks atop of [Finagle][finagle] for\nbuilding composable HTTP APIs. Its mission is to provide the developers simple and robust HTTP primitives being as\nclose as possible to the bare metal Finagle API.\n\nBadges\n------\n[![Scala CI](https://github.com/finagle/finch/actions/workflows/build.yml/badge.svg)](https://github.com/finagle/finch/actions/workflows/build.yml)\n[![Coverage Status](https://img.shields.io/codecov/c/github/finagle/finch/master.svg)](https://codecov.io/github/finagle/finch)\n[![Gitter](https://img.shields.io/badge/gitter-join%20chat-green.svg)](https://gitter.im/finagle/finch?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n[![Maven Central](https://img.shields.io/maven-central/v/com.github.finagle/finch-core_2.11.svg)](https://index.scala-lang.org/finagle/finch/finch-core)\n\nStandard Modules\n----------------\nFinch uses multi-project structure and contains of the following _modules_:\n\n* [`finch-core`](core) - core classes/functions\n* [`finch-generic`](generic) - generic derivation for endpoints\n* [`finch-argonaut`](argonaut) - [Argonaut][argonaut] + Finch\n* [`finch-circe`](circe) - [Circe][circe] + Finch\n* [`finch-iteratee`](iteratee) - [Iteratee][iteratee] + Finch\n* [`finch-fs2`](fs2) - [FS2][fs2] + Finch\n* [`finch-refined`](refined) - [Refined][refined] + Finch\n* [`finch-test`](test) - the test support classes/functions\n\nAdditional Modules\n------------------\n\nFinch's Github organization has even more modules (these are, however, not published regularly;\nreach out if you need published artifacts):\n\n* [`finch-jackson`][finch-jackson] - [Jackson][jackson] + Finch\n* [`finch-json4s`][finch-json4s] - [JSON4s][json4s] + Finch\n* [`finch-playjson`][finch-playjson] - [PlayJson][playjson] + Finch\n* [`finch-sprayjson`][finch-sprayjson] - [SprayJson][sprayjson] + Finch\n* [`finch-oauth2`][finch-oauth2] - [Finagle OAuth2][finagle-oauth2] + Finch\n\nInstallation\n------------\nEvery Finch module is published at Maven Central. Use the following _sbt_ snippet ...\n\n```scala\nlibraryDependencies ++= Seq(\n  \"com.github.finagle\" %% \"[finch-module]\" % \"[version]\"\n)\n```\n\nHello World!\n------------\nThis \"Hello World!\" example is built with just `finch-core`:\n\n```scala\nimport cats.effect.{IO, IOApp}\nimport io.finch._\n\nobject Main extends IOApp.Simple with Endpoint.Module[IO] {\n  override def run: IO[Unit] = {\n    val api: Endpoint[IO, String] = get(\"hello\") { Ok(\"Hello, World!\") }\n    Bootstrap[IO].serve[Text.Plain](api).listen(\":8080\").useForever\n  }\n}\n```\n\nSee [examples](examples/src/main/scala/io/finch) sub-project for more complete examples.\n\nQuickstart\n----------\n\nUse [finch.g8][finch.g8] template to quickly bootstrap a minimal Finch project:\n\n - `sbt new finch/finch.g8`\n - `cd helloworld`\n - `sbt run`\n - `curl http://localhost:8081/hello`\n\nPerformance\n-----------\n\nWe use [wrk][wrk] to load test [Finch+Circe][finch-bench] against [Finagle+Jackson][finagle-bench]\nto get some insight on how much overhead, an idiomatic Finch application written in a purely\nfunctional way, involves on top of Finagle/Jackson. The results are quite impressive (for a pre-1.0\nversion): Finch performs on **95% of Finagle's throughput**.\n\nHere is the first three runs of the benchmark on 2013 MB Pro (2.8 GHz Intel Core i7 w/ 16G RAM).\n\n| Benchmark         | Run 1          | Run 2          | Run 3          |\n|-------------------|----------------|----------------|----------------|\n| Finagle + Jackson | 29014.68 req/s | 36783.21 req/s | 39924.42 req/s |\n| Finch + Circe     | 28762.84 req/s | 36876.30 req/s | 37447.52 req/s |\n\nFinch is also load tested against a number of Scala HTTP frameworks and libraries as part of the\n[TechEmpower benchmark][tempower]. The most recent round showed that Finch performs really well\nthere, [scoring a second place][finch-is-fast] across all the Scala libraries.\n\nDocumentation\n-------------\n* The main documentation is hosted at http://finagle.github.io/finch/\n* The documentation source may be found in the [`docs/`](docs/) folder\n* The latest Scaladoc is available at http://finagle.github.io/finch/api/\n\nAdopters\n--------\n* [PITS Global Data Recovery Services](https://www.pitsdatarecovery.net/)\n* [Despegar](http://www.despegar.com)\n* [Earnest](http://meetearnest.com)\n* [Globo.com](http://globo.com)\n* [Glopart](https://glopart.ru)\n* [Hotel Urbano](http://www.hotelurbano.com)\n* [Konfettin](http://konfettin.ru)\n* [JusBrasil](http://www.jusbrasil.com.br)\n* [Sabre Labs](http://sabrelabs.com)\n* [Spright](http://spright.com)\n* [SoFi](https://www.sofi.com/)\n* [Qubit](http://www.qubit.com)\n* [QuizUp](http://www.quizup.com)\n* [Lookout](http://www.lookout.com)\n* [Project September](http://projectseptember.com/)\n* [Merit](https://merits.com)\n* [D.A.Consortium](http://www.dac.co.jp/english/)\n* [Redbubble](https://redbubble.com/)\n* [Zalando](https://zalando.de)\n* [Rakuten](http://rakuten.co.jp)\n* [Threat Stack](https://www.threatstack.com/)\n* [RelinkLabs](https://relinklabs.com/)\n* *Submit a pull-request to include your company/project into the list*\n\nRelated Projects\n----------------\n\n* [Finch Template](https://github.com/redbubble/finch-template): A Redbubble approach to building services with Finch\n* [Finch Server](https://github.com/BenWhitehead/finch-server): Finch's integration into TwitterServer\n* [Finch Sangria](https://github.com/redbubble/finch-sangria): Finch's GraphQL support\n* [Finch Demo](https://github.com/slouc/finch-demo): Community-maintained Finch user guide\n* [Finch Rich](https://github.com/akozhemiakin/finchrich): Macro-based controllers for Finch\n* [Finch Quickstart](https://github.com/zdavep/finch-quickstart): A skeleton Finch project\n* [Finch OAuth2](https://github.com/finch/finch-oauth2): the OAuth2 support backed by the [finagle-oauth2][finagle-oauth2] library\n* [Finch Todo Backend](https://github.com/ilya-murzinov/finch-todo-backend): Finch implementation of [todobackend](http://www.todobackend.com/)\n\nContributing\n------------\nThere are plenty of ways to contribute into Finch:\n\n* Give it a star\n* Join the [Gitter][gitter] room and leave a feedback or help with answering users' questions\n* [Submit a PR](CONTRIBUTING.md) (there is an issue label [\"easy\"](https://github.com/finagle/finch/issues?q=is%3Aopen+is%3Aissue+label%3Aeasy) for newcomers)\n* Be cool and wear a [Finch T-Shirt](http://www.redbubble.com/people/vkostyukov/works/13277123-finch-io-rest-api-with-finagle?p=t-shirt)\n\nThe Finch project supports the [Typelevel][typelevel] [code of conduct][conduct] and wants all of its channels\n(Gitter, GitHub, etc.) to be welcoming environments for everyone.\n\nFinch is currently maintained by [Vladimir Kostyukov][vkostyukov], [Travis Brown][travisbrown],\n[Ryan Plessner][ryan_plessner], and [Sergey Kolbasov][sergey_kolbasov]. After the 1.0 release, all\npull requests will require two sign-offs by a maintainer to be merged.\n\nLicense\n-------\nLicensed under the **[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)** (the \"License\");\nyou may not use this software except in compliance with the License.\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n[gitter]: https://gitter.im/finagle/finch\n[finagle]: https://github.com/twitter/finagle\n[circe]: https://github.com/circe/circe\n[jackson]: https://github.com/FasterXML/jackson\n[argonaut]: http://argonaut.io\n[finagle-oauth2]: https://github.com/finagle/finagle-oauth2\n[json4s]: http://json4s.org\n[playjson]: https://www.playframework.com/documentation/2.6.x/ScalaJson\n[sprayjson]: https://github.com/spray/spray-json\n[iteratee]: https://github.com/travisbrown/iteratee\n[refined]: https://github.com/fthomas/refined\n[scaladoc]: http://finagle.github.io/finch/docs/#io.finch.package\n[typelevel]: http://typelevel.org/\n[conduct]: http://typelevel.org/conduct.html\n[wrk]: https://github.com/wg/wrk\n[finch-bench]: https://github.com/finagle/finch/blob/master/examples/src/main/scala/io/finch/wrk/Finch.scala\n[finagle-bench]: https://github.com/finagle/finch/blob/master/examples/src/main/scala/io/finch/wrk/Finagle.scala\n[finagle-oauth2]: https://github.com/finagle/finagle-oauth2\n[finch.g8]: https://github.com/finch/finch.g8\n[tempower]: https://www.techempower.com/benchmarks/#section=data-r12\u0026hw=peak\u0026test=json\u0026l=6bk\n[finch-is-fast]: http://vkostyukov.net/posts/how-fast-is-finch/\n[finch-jackson]: https://github.com/finch/finch-jackson\n[finch-json4s]: https://github.com/finch/finch-json4s\n[finch-sprayjson]: https://github.com/finch/finch-sprayjson\n[finch-playjson]: https://github.com/finch/finch-playjson\n[finch-oauth2]: https://github.com/finch/finch-oauth2\n[fs2]: https://github.com/functional-streams-for-scala/fs2\n[vkostyukov]: https://twitter.com/vkostyukov\n[travisbrown]: https://twitter.com/travisbrown\n[ryan_plessner]: https://twitter.com/ryan_plessner\n[sergey_kolbasov]: https://twitter.com/sergey_kolbasov\n","funding_links":[],"categories":["Scala","\u003e 1k ★","HTTP","Table of Contents"],"sub_categories":["HTTP"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffinagle%2Ffinch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffinagle%2Ffinch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffinagle%2Ffinch/lists"}