https://github.com/rolang/google-rest-api-codegen
(Experimental) Google REST APIs client code generator
https://github.com/rolang/google-rest-api-codegen
code-generator experimental google-api-client google-apis google-cloud jsoniter jsoniter-scala scala scala-native scala3 sttp zio-json
Last synced: 10 months ago
JSON representation
(Experimental) Google REST APIs client code generator
- Host: GitHub
- URL: https://github.com/rolang/google-rest-api-codegen
- Owner: rolang
- License: mit
- Created: 2024-09-25T03:51:20.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-15T05:51:08.000Z (10 months ago)
- Last Synced: 2025-03-15T06:29:15.945Z (10 months ago)
- Topics: code-generator, experimental, google-api-client, google-apis, google-cloud, jsoniter, jsoniter-scala, scala, scala-native, scala3, sttp, zio-json
- Language: Scala
- Homepage:
- Size: 413 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# (Experimental) Google APIs client code generator
[](https://oss.sonatype.org/content/repositories/snapshots/dev/rolang/gcp-codegen_3/)
⚠️ _This project is in an experimental stage (with a messy code base), use with care if you want to give it a try_.
Generates client code from Google's [disovery document](https://developers.google.com/discovery/v1/using) for your Scala (3) tech stack.
Currently it provides following configurations for generated code:
- Http sources: [Sttp4](https://sttp.softwaremill.com/en/latest), [Sttp3](https://sttp.softwaremill.com/en/stable)
- JSON codecs: [Jsoniter](https://github.com/plokhotnyuk/jsoniter-scala), [ZioJson](https://zio.dev/zio-json)
- JSON Array collection type: `List`, `Vector`, `Array`, `ZioChunk`
__NOTE__: Generated code does not include authentication.
If you're using [http4s](https://github.com/http4s/http4s) and [circe](https://github.com/circe/circe) you may also want to check some similar projects:
- [hamnis/google-discovery-scala](https://github.com/hamnis/google-discovery-scala)
- [armanbilge/gcp4s](https://github.com/armanbilge/gcp4s)
### Usage
The generator can be used with any tool that can perform system calls to a command line executable or add Scala 3 dependencies (e.g. [scala command line](https://scala-cli.virtuslab.org/), [sbt 1](https://www.scala-sbt.org/1.x/docs/), [sbt 2](https://www.scala-sbt.org/2.x/docs/en/index.html), [mill](https://mill-build.org), etc.).
#### Usage via Scala command line example
See example under [example/generate.scala](./example/generate.scala).
```scala
//> using scala 3.6.3
//> using dep dev.rolang::gcp-codegen::0.0.2
import gcp.codegen.*, java.nio.file.*, GeneratorConfig.*
@main def run =
val files = Task(
specsInput = SpecsInput.FilePath(Path.of("pubsub_v1.json")),
config = GeneratorConfig(
outDir = Path.of("out"),
outPkg = "example.pubsub.v1",
httpSource = HttpSource.Sttp4,
jsonCodec = JsonCodec.Jsoniter,
dialect = Dialect.Scala3,
arrayType = ArrayType.List,
preprocess = specs => specs
)
).runAwait()
println(s"Generated ${files.length} files")
```
Run example:
```shell
cd example && scala generate.scala && scala fmt ./out
```
See output in `example/out`.
#### Command-line executable usage
##### Configuration parameters (currently supported):
| Configuration | Description | Options | Default |
| ------------------- | ---------------- | ------- | --- |
| -specs | Can be `stdin` or a path to the JSON file. | | |
| -out-dir | Ouput directory | | |
| -out-pkg | Output package | | |
| -http-source | Generated http source. | [Sttp4](https://sttp.softwaremill.com/en/latest), [Sttp3](https://sttp.softwaremill.com/en/stable) | |
| -json-codec | Generated JSON codec | [Jsoniter](https://github.com/plokhotnyuk/jsoniter-scala), [ZioJson](https://zio.dev/zio-json) | |
| -array-type | Collection type for JSON arrays | `List`, `Vector`, `Array`, `ZioChunk` | `List` |
| -include-resources | Optional resource filter. | | |
##### Examples:
_Command line binaries are not published (not yet).
A command line binary can be built from the source via `sbt buildCliBinary`.
The output directory is `modules/cli/target/bin`.
E.g. on Linux the output file will be like `modules/cli/target/bin/gcp-codegen-x86_64-linux`._
```shell
curl 'https://pubsub.googleapis.com/$discovery/rest?version=v1' > pubsub_v1.json
# the path to the executable may be different
./modules/cli/target/bin/gcp-codegen-x86_64-linux \
-out-dir=src/scala/main/generated \
-specs=./pubsub_v1.json \
-out-pkg=gcp.pubsub.v1 \
-http-source=sttp4 \
-json-codec=jsoniter \
-include-resources='projects.*,!projects.snapshots' # optional filters
```
### Building and testing
Generate, compile and run tests for generated code
```shell
sbt buildCliBinary test
```