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
description string
values required[enum_value]

enum_value

Example JSON: |
FieldType
name requiredstring
description string

field

Example JSON: |
FieldTypeDescription
name requiredstring
type requiredstring
description string
default string
required requiredbooleandefault: true
minimum long
maximum long
example string

model

Example JSON: |
FieldTypeDescription
plural string Defaults to the plural of the model name. Used to generate resource paths which by default map to the plural of the model name
description string
fields required[field]

operation

Example JSON: |
FieldTypeDescription
method requiredmethod
path string
description string
body body
parameters [parameter]
responses map[response] Keys are HTTP status codes

parameter

Example JSON: |
FieldTypeDescription
name requiredstring
type requiredstring
location parameter_location
description string
required requiredbooleandefault: true
default string
minimum long
maximum long
example string

resource

Example JSON: |
FieldTypeDescription
description string
path string Defaults to the plural of the model name
operations required[operation]

response

Example JSON: |
FieldType
type requiredstring

service

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