Documentation for an apibuilder code generator API
| Method and Path | Description | ||
|---|---|---|---|
| GET | /generators | Get all available generators |
|
| GET | /generators/:key | Get generator with this key |
|
| https://app.apibuilder.io/apicollective/apibuilder-common/latest/service.json |
| https://app.apibuilder.io/apicollective/apibuilder-spec/latest/service.json |
Allows generator authors to flag files with special characteristics. It is up to the client (i.e. the cli) to decide how to interpret them.
| Name | Value | Description |
|---|---|---|
| scaffolding | scaffolding | Indicates files that an end user starts from but should edit. Not intended to be the final product (see: https://stackoverflow.com/questions/235018/what-is-scaffolding-is-it-a-term-for-a-particular-platform). Consider not overwriting these files when code is re-generated.
|
Interfaces: None
An attribute represents a key/value pair that is optionally used to provide additional instructions / data to the code generator. An example could be an attribute to specify the root import path for a go client..
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| name | string | Yes | - |
|
| value | string | Yes | - |
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| code | string | Yes | - | Machine readable code for this specific error message
|
| message | string | Yes | - | Description of the error
|
Interfaces: None
Represents a source file
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| name | string | Yes | - | The recommended name for the file.
Example: ApiCollectiveApiBuilderApiClient.scala |
| dir | string | No | - | The recommended directory path for the file where appropriate.
Example: io/apicollective/apibuilder |
| contents | string | Yes | - | The actual source code.
|
| flags | [file_flag] | No | - |
|
Interfaces: None
The generator metadata.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| key | string | Yes | - |
|
| name | string | Yes | - |
|
| language | string | No | - | A comma separate list of the programming language(s) that this generator produces
Example: scala |
| description | string | No | - |
|
| attributes | [string] | Yes | [] | The list of attributes that this code generator can use. You can find the full list of available attributes and their descriptions at http://apibuilder.io/doc/attributes
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| status | string | Yes | - |
Example: healthy |
Interfaces: None
The result of invoking a generator.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| source | string | Yes | - | The actual source code.
deprecated:
Use files instead |
| files | [file] | Yes | - | A collection of source files
|
Interfaces: None
The invocation form is the payload send to the code generators when requesting generation of client code.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| service | io.apibuilder.spec.v0.models.service:0.16.53 | Yes | - |
|
| attributes | [attribute] | Yes | [] |
|
| user_agent | string | No | - |
|
| imported_services | [io.apibuilder.spec.v0.models.service:0.16.53] | No | - |
|
