Attributes fed to Scala-based code generatros
These are attributes that may be supplied at the field level of a model.
Scala not-required fields with defaults may be modeled in one of two ways:
Optional: the field's concrete type is wrapped in an Option. This permits a client to choose not to set the field when creating an object, thus forcing the server to apply its default. The value will never be null at the server.
{"name": "scala_generator", "value": {"model_hint": "optional"}}
Required: the field's concrete type (String, List[T], JsObject) is used. A client must set its own default for the field, and the server will set its own default if one were missing. This makes it possible to introduce a new field to an existing model without requiriing an Option on its signature, but it makes it more difficult to determine where the default was set.
{"name": "scala_generator", "value": {"model_hint": "required"}}
The global default is required
Code Generators Using this Attribute
| Service | Key | Name | Language | Attributes | Description |
|---|---|---|---|---|---|
| https://generator.apibuilder.io | anorm_2_6_parsers | Anorm 2.6 parsers | Scala | scala_generator | Generates anorm parsers. Depends on apidoc_0_x_libs generators. See... |
| https://generator.apibuilder.io | anorm_2_8_parsers | Anorm 2.8 parsers | Scala | scala_generator | Generates anorm parsers. Depends on apidoc_0_x_libs generators. See... |
| https://generator.apibuilder.io | anorm_2_9_scala_3_parsers | Anorm 2.9 Scala 3 parsers | Scala | scala_generator | Generates anorm parsers. See https://playframework.github.io/anorm/ |
| https://generator.apibuilder.io | anorm_2_x_parsers | Anorm 2.x parsers | Scala | scala_generator | Generates anorm parsers. Depends on apidoc_0_x_libs generators. See... |
| https://generator.apibuilder.io | http4s_0_15 | Http4s 0.15 / 0.16 | Scala | scala_generator | Http4s 0.15 and 0.16 client based on <a... |
| https://generator.apibuilder.io | http4s_0_17 | Http4s 0.17 | Scala | scala_generator | Http4s 0.17 client based on <a... |
| https://generator.apibuilder.io | http4s_0_18 | Http4s 0.18 | Scala | scala_generator | Http4s 0.18 client based on <a... |
| https://generator.apibuilder.io | http4s_0_20 | Http4s 0.20 | Scala | scala_generator | Http4s 0.20 client based on <a... |
| https://generator.apibuilder.io | http4s_0_22 | Http4s 0.22 | Scala | scala_generator | Http4s 0.22 client based on <a... |
| https://generator.apibuilder.io | http4s_0_23 | Http4s 0.23 | Scala | scala_generator | Http4s 0.23 client. Warning, no Server support (yet), see issue #662 |
| https://generator.apibuilder.io | play_2_2_client | Play 2.2 client | Scala | scala_generator | Play Framework 2.2 client based on <a... |
| https://generator.apibuilder.io | play_2_3_client | Play 2.3 client | Scala | scala_generator | Play Framework 2.3 client based on <a... |
| https://generator.apibuilder.io | play_2_4_client | Play 2.4 client | Scala | scala_generator | Play Framework 2.4 client based on <a... |
| https://generator.apibuilder.io | play_2_4_mock_client | Play 2.4 Mock Client | Java, Scala | scala_generator | Provides a mock client with non functional, but compiling stubs, that can... |
| https://generator.apibuilder.io | play_2_5_client | Play 2.5 client | Scala | scala_generator | Play Framework 2.5 client based on <a... |
| https://generator.apibuilder.io | play_2_5_mock_client | Play 2.5 Mock Client | Java, Scala | scala_generator | Provides a mock client with non functional, but compiling stubs, that can... |
| https://generator.apibuilder.io | play_2_6_client | Play 2.6 client | Scala | scala_generator | Play Framework 2.6 client based on <a... |
| https://generator.apibuilder.io | play_2_6_mock_client | Play 2.6 Mock Client | Java, Scala | scala_generator | Provides a mock client with non functional, but compiling stubs, that can... |
| https://generator.apibuilder.io | play_2_7_client | Play 2.7 client | Scala | scala_generator | Play Framework 2.7 client based on <a... |
| https://generator.apibuilder.io | play_2_8_client | Play 2.8 client | Scala | scala_generator | Play Framework 2.8 client based on <a... |
| https://generator.apibuilder.io | play_2_8_mock_client | Play 2.8 Mock Client | Java, Scala | scala_generator | Provides a mock client with non functional, but compiling stubs, that can... |
| https://generator.apibuilder.io | play_2_9_scala_3_client | Play 2.9 with scala3 client | Scala | scala_generator | Play Framework 2.9 + scala 3 client based on <a... |
| https://generator.apibuilder.io | play_2_x_json | Play 2.x json | Scala | scala_generator | Generate play 2.x case classes with json serialization based on <a... |
| https://generator.apibuilder.io | play_2_x_scala_3_json | Play 2.x Scala 3 json | Scala | scala_generator | Generate play 2.x with scala 3 support case classes with json serialization... |
| https://generator.apibuilder.io | play_2_x_scala_3_standalone_json | Play 2.x Scala 3 standalone json | Scala | scala_generator | Generate case class with json serialization based on play-json, but do NOT... |
| https://generator.apibuilder.io | play_2_x_standalone_json | Play 2.x standalone json | Scala | scala_generator | Generate case class with json serialization based on play-json, but do NOT... |
| https://generator.apibuilder.io | scalacheck | ScalaCheck | Scala | scala_generator | Generate ScalaCheck... |
| https://generator.apibuilder.io | scala_mock_models | Scala mock models | Scala | scala_generator | Generate factory methods for mock models from the API description. |
| https://generator.apibuilder.io | scala_models | Scala models | Scala | scala_generator | Generate scala models from the API description. |