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

import

Example JSON: |

An import is used to declare a dependency on another service. This allows you to reference the models and or enums from that service in your own service.

FieldTypeDescription
uri requiredstring Full URI to the service.json file of the service we are importing e.g. http://www.apidoc.me/gilt/apidoc-spec/0.7.38/service.json
namespace requiredstring
organization_key requiredstring
application_key requiredstring
version requiredstring

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
key requiredstring Unique key to identify this service. URL friendly
namespace requiredstring Fully qualified namespace for this service - e.g. com.gilt.apidoc.
version requiredstring e.g. 1.0.0
base_url string
description string
headers required[header]
imports required[import]
enums required[enum]
models required[model]
resources required[resource] keys are the names of a model