API | BUILDER

Specification of apidoc api.json schema

Base URL: http://api.apidoc.me

body

Example JSON: |
FieldType
type requiredstring
description string

enum

Example JSON: |
FieldType
name requiredstring
description string
values required[enum_value]

enum_value

Example JSON: |
FieldType
name requiredstring
description string

field

Example JSON: |
FieldType
name requiredstring
type requiredstring
description string
default string
required requiredboolean
minimum long
maximum long
example string

model

Example JSON: |
FieldType
name requiredstring
plural requiredstring
description string
fields required[field]

operation

Example JSON: |
FieldType
method requiredmethod
path requiredstring
description string
body body
parameters [parameter]
responses [response]

parameter

Example JSON: |
FieldType
name requiredstring
type requiredstring
location requiredparameter_location
description string
required requiredboolean
default string
minimum long
maximum long
example string

resource

Example JSON: |
FieldType
model requiredmodel
description string
operations required[operation]

response

Example JSON: |
FieldType
code requiredinteger
type requiredstring

service

Example JSON: |
FieldTypeDescription
name requiredstring
base_url string
description string
headers required[header]
enums required[enum]
models required[model]
resources required[resource] keys are the names of a model