akka-http-scalapb

KO | EN

gitlite — search

#react #typescript #llm #golang #rust #deep-learning #linux #docker #macos #windows #vue #security #ios #open-source

akka-http-scalapb

(★ 15)

akka-http protobuf binary and json marshalling/unmarshalling for ScalaPB messages

akka-http-scalapb 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# akka-http-scalapb

[![Continuous Integration](https://github.com/RustedBones/akka-http-scalapb/actions/workflows/ci.yml/badge.svg)](https://github.com/RustedBones/akka-http-scalapb/actions/workflows/ci.yml)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/fr.davit/akka-http-scalapb_2.12/badge.svg)](https://maven-badges.herokuapp.com/maven-central/fr.davit/akka-http-scalapb_2.12)
[![Software License](https://img.shields.io/badge/license-Apache%202-brightgreen.svg?style=flat)](https://raw.githubusercontent.com/RustedBones/akka-http-scalapb/main/LICENSE)
[![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org)

akka-http protobuf and json marshalling/unmarshalling for ScalaPB messages

After the akka [licencing change](https://www.lightbend.com/blog/why-we-are-changing-the-license-for-akka),
no further development is expected on `akka-http-scalapb`.
If you're migrating to pekko-http, see [pekko-http-scalapb](https://github.com/RustedBones/pekko-http-scalapb).

## Versions

| Version | Release date | Akka Http version | ScalaPB version            | Scala versions                |
|---------|--------------|-------------------|----------------------------|-------------------------------|
| `0.2.5` | 2022-02-06   | `10.2.7`          | `0.11.5` (`0.12.0` json4s) | `2.13.8`, `2.12.15`           |
| `0.2.4` | 2021-03-24   | `10.2.4`          | `0.11.0` (`0.11.0` json4s) | `2.13.5`, `2.12.13`           |
| `0.2.3` | 2020-09-18   | `10.2.0`          | `0.10.8` (`0.10.1` json4s) | `2.13.3`, `2.12.12`           |
| `0.2.2` | 2020-05-10   | `10.1.11`         | `0.10.3` (`0.10.1` json4s) | `2.13.2`, `2.12.11`           |
| `0.2.1` | 2019-07-13   | `10.1.8`          | `0.9.0`  (`0.9.2` json4s)  | `2.13.0`, `2.12.8`, `2.11.12` |
| `0.2.0` | 2019-06-22   | `10.1.8`          | `0.9.0`  (`0.9.2` json4s)  | `2.13.0`, `2.12.8`, `2.11.12` |
| `0.1.0` | 2019-01-27   | `10.1.7`          | `0.8.4`  (`0.7.2` json4s)  | `2.12.8`, `2.11.12`           |

The complete list can be found in the [CHANGELOG](CHANGELOG.md) file.

## Getting akka-http-scalapb

Libraries are published to Maven Central. Add to your `build.sbt`:

```scala
libraryDependencies += "fr.davit" %% "akka-http-scalapb" % <version> // binary & json support
```

## Quick start

For the examples, we are using the following proto domain model

```proto
message Item {
  string name = 1;
  int64 id    = 2;
}

message Order {
  reapeated Item items = 1;
}
```

The implicit marshallers and unmarshallers for your generated proto classes are defined in `ScalaPBSupport`. You
simply need to have them in scope.

```scala
import akka.http.scaladsl.server.Directives._
import fr.davit.akka.http.scaladsl.marshallers.scalapb.ScalaPBSupport._

object MyProtoService {

val route =
    get {
      pathSingleSlash {
        complete(Item("thing", 42))
      }
    } ~ post {
      entity(as[Order]) { order =>
        val itemsCount = order.items.size
        val itemNames = order.items.map(_.name).mkString(", ")
        complete(s"Ordered $itemsCount items: $itemNames")
      }
    }
}
```

Marshalling/Unmarshalling of the generated classes depends on the `Accept`/`Content-Type` header sent by the client:
- `Content-Type: application/json`: json
- `Content-Type: application/x-protobuf`: binary
- `Content-Type: application/x-protobuffer`: binary
- `Content-Type: application/protobuf`: binary
- `Content-Type: application/vnd.google.protobuf`: binary

No `Accept` header or matching several (eg `Accept: application/*`) will take the 1st matching type from the above list.

### Json only

If you are using scalaPB for json (un)marshalling only, you can use `ScalaPBJsonSupport` from the sub module

```scala
libraryDependencies += "fr.davit" %% "akka-http-scalapb-json4s" % <version> // json support only
```

### Binary only

If you are using scalaPB for binary (un)marshalling only, you can use `ScalaPBBinarySupport` form the sub module

```scala
libraryDependencies += "fr.davit" %% "akka-http-scalapb-binary" % <version> // binary support only
```

## Limitation

Only json (un)marshallers are able to support collections of proto messages as root object.

Entity streaming (http chunked transfer) is at the moment not supported by the library.

akka-http-scalapb

akka-http-scalapb 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

akka-http-scalapb

akka-http-scalapb 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README