API | BUILDER

Specification of the API Builder Input form (api.json). See https://app.apibuilder.io/doc/apiJson

Contact: Michael Bryzek mbryzek@alum.mit.edu http://twitter.com/mbryzek

License: MIT

annotation

Example JSON: |
FieldType
description string
deprecation deprecation

api_json

Example JSON: |
FieldTypeDescription
name requiredstring
info info
namespace string
base_url string
description string
imports [import]default: []
headers [header]default: []
enums map[enum]default: {}
interfaces map[interface]default: {}
templates templates
unions map[union]default: {}
models map[model]default: {}
resources map[resource]default: {}
annotations map[annotation]default: {}
attributes [attribute]default: []

attribute

Example JSON: |
FieldType
name requiredstring
value requiredobject

body

Example JSON: |
FieldType
type requiredstring
description string
attributes [attribute]
deprecation deprecation

contact

Example JSON: |
FieldTypeDescription
name string e.g. Michael Bryzek
url string e.g. https://www.apibuilder.io
email string e.g. michael@test.apibuilder.io

deprecation

Example JSON: |
FieldType
description string

enum

Example JSON: |
FieldType
plural string
description string
values required[enum_value]
attributes [attribute]
deprecation deprecation

enum_value

Example JSON: |
FieldType
name requiredstring
value string
description string
attributes [attribute]
deprecation deprecation

field

Example JSON: |
FieldTypeDescription
name requiredstring
type requiredstring
description string
required booleandefault: true
default json
example string
minimum long
maximum long
attributes [attribute]
annotations [string]
deprecation deprecation

import

Example JSON: |
FieldType
uri requiredstring

info

Example JSON: |
FieldType
contact contact
license license

interface

Example JSON: |
FieldType
plural string
description string
fields [field]
attributes [attribute]
deprecation deprecation

license

Example JSON: |

Describes the software license contact for this service

FieldTypeDescription
name requiredstring e.g. MIT
url string e.g. http://opensource.org/licenses/MIT

model

Example JSON: |
FieldTypeDescription
description string
plural string
fields [field]default: []
attributes [attribute]
interfaces [string]
templates [template_declaration]
deprecation deprecation

operation

Example JSON: |
FieldType
method requiredstring
path string
description string
body body
parameters [parameter]
responses map[response]
attributes [attribute]
deprecation deprecation

parameter

Example JSON: |
FieldTypeDescription
name requiredstring
type requiredstring
location parameter_locationdefault: query
description string
required booleandefault: true
default json
minimum long
maximum long
example string
attributes [attribute]
deprecation deprecation

resource

Example JSON: |
FieldTypeDescription
path string
description string
operations [operation]default: []
attributes [attribute]
templates [template_declaration]
deprecation deprecation

response

Example JSON: |
FieldType
type requiredstring
headers [header]
description string
deprecation deprecation
attributes [attribute]

template_declaration

Example JSON: |
FieldTypeDescription
name requiredstring
cast map[string] Casts the types declared in the template to the types you want to use in this declaration

templates

Example JSON: |

Experimental

FieldType
models map[model]
resources map[resource]

union

Example JSON: |
FieldTypeDescription
plural string
discriminator string
description string
types required[union_type] min: 1
attributes [attribute]
interfaces [string]
deprecation deprecation

union_type

Example JSON: |
FieldTypeDescription
type requiredstring
description string
default booleandefault: false
discriminator_value string
attributes [attribute]
deprecation deprecation