Formatter Validator Minifier Escape / Unescape JSON ↔ String JSON ↔ YAML JSON → CSV NDJSON / JSON Lines JSON → Types JSON ↔ XML JSON Diff JSON Patch Canonicalize (RFC 8785) Schema Validator Schema Generator JSONPath Tester JWT Decoder JSON Errors Schemas More Tools
JSONTools / Schema registry / API Builder
Schema registry

API Builder

apibuilder.io

**/api.json
Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your **/api.json and it validates in your browser — nothing is uploaded.

Validate a **/api.json → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field Type Description
$schemastringA JSON schema URL
namerequiredstringThe human readable name of this service. Used for display, and as the basis for generating a unique key for URL.
apidocobject—
apidoc.versionrequiredstringSpecifies the version of the API Builder specification that this file is written for. The latest version can be found by visiting /apicollective/apibuilder-spec.
infoobject—
info.contactobjectSpecifies contact information for this service
info.contact.namestringIdentifying name of the contact person/organization
info.contact.urlstringURL pointing to the contact information
info.contact.emailstringEmail address of the contact person/organization
info.licenseobjectspecifies the license under which this service is released
info.license.namerequiredstringName of the license
info.license.urlstringURL of the license itself
namespacestringSpecifies the namespace for this service. Namespace is primarily used when other services import definitions from your service and in the code generators when defining things like package names. If not specified, we will automatically
base_urlstringThe base URL where this service is hosted. Must start with http.
descriptionstringoptional description for what this service provides. Supports GFM.
importsarrayJSON Array defining any other services whose schema definitions we would like to import into our service.
headersarrayJSON Array defining any HTTP Headers that the service understands or expects.
enumsobject—
interfacesobject—
modelsobjectspecifies the name of the model. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, interfaces, models, or unions types.
unionsobject—
resourcesobject—
attributesarrayJSON Array defining additional meta data about this service. Attributes are used to add custom extensions to API Builder and are typically used by generators to enable advanced code generation.
annotationsobject—
Audit

What we found in this schema

Standards

Specification sections for the keywords in this schema

Keyword Document Section
$idJSON Schema Core, draft 2020-12§8.2.1 — The "$id" Keyword
$refJSON Schema Core, draft 2020-12§8.2.3.1 — Direct References with "$ref"
$schemaJSON Schema Core, draft 2020-12§8.1.1 — "$schema"
additionalPropertiesJSON Schema Core, draft 2020-12§10.3.2.3 — "additionalProperties"
defaultJSON Schema Validation, draft 2020-12§9.2 — "default"
descriptionJSON Schema Validation, draft 2020-12§9.1 — "title" and "description"
enumJSON Schema Validation, draft 2020-12§6.1.2 — "enum"
itemsJSON Schema Core, draft 2020-12§10.3.1.2 — "items"
maximumJSON Schema Validation, draft 2020-12§6.2.2 — "maximum"
minimumJSON Schema Validation, draft 2020-12§6.2.4 — "minimum"
patternJSON Schema Validation, draft 2020-12§6.3.3 — "pattern"
patternPropertiesJSON Schema Core, draft 2020-12§10.3.2.2 — "patternProperties"
propertiesJSON Schema Core, draft 2020-12§10.3.2.1 — "properties"
requiredJSON Schema Validation, draft 2020-12§6.5.3 — "required"
typeJSON Schema Validation, draft 2020-12§6.1.1 — "type"

Documents

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas