Documentation for an apibuilder code generator API
Base URL: https://api.apibuilder.io
Contact: Michael Bryzek mbryzek@alum.mit.edu http://twitter.com/mbryzek
License: MIT
generator
Path: /generators
GET
/generators Get all available generators
Parameters
| Name | Type | Description |
|---|---|---|
| key | string | Query Filter generators with this key |
| limit required | integer | Query default: 100 The number of records to return (min: 0) |
| offset required | integer | Query default: 0 Used to paginate. First page of results is 0. (min: 0) |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | [generator] |
GET
/generators/:key Get generator with this key
Parameters
| Name | Type | Description |
|---|---|---|
| key required | string | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | generator | |
| 404 | unit |
healthcheck
Path: /_internal_/healthcheck
GET
/_internal_/healthcheck Responses
| Code | Type | Description |
|---|---|---|
| 200 | healthcheck |
invocation
Path: /invocations
POST
/invocations/:key Invoke a generator
Body
Parameters
| Name | Type | Description |
|---|---|---|
| key required | string | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | invocation | |
| 409 | [error] |