Schema.org · JSON Structure

Schema Org Web Api

An application programming interface accessible over Web/Internet technologies.

Type: object Properties: 12 Required: 1

Schema.orgStructured DataLinked DataJSON-LDVocabularySEOWeb StandardsRDFOntology

WebAPI is a JSON Structure definition published by Schema.org, describing 12 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

type context name description url documentation termsOfService provider availableChannel category offers audience

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "type": "object",
  "name": "WebAPI",
  "description": "An application programming interface accessible over Web/Internet technologies.",
  "properties": {
    "type": { "type": "string" },
    "context": { "type": "string" },
    "name": { "type": "string" },
    "description": { "type": "string" },
    "url": { "type": "string" },
    "documentation": { "type": "string" },
    "termsOfService": { "type": "string" },
    "provider": { "type": { "$ref": "schema-org-organization.json" } },
    "availableChannel": { "type": { "$ref": "#/definitions/ServiceChannel" } },
    "category": { "type": "string" },
    "offers": { "type": "array", "items": { "type": { "$ref": "schema-org-offer.json" } } },
    "audience": { "type": { "$ref": "#/definitions/Audience" } }
  },
  "required": ["name"],
  "definitions": {
    "ServiceChannel": {
      "type": "object",
      "name": "ServiceChannel",
      "properties": {
        "type": { "type": "string" },
        "serviceUrl": { "type": "string" },
        "providesService": { "type": "string" }
      }
    },
    "Audience": {
      "type": "object",
      "name": "Audience",
      "properties": {
        "type": { "type": "string" },
        "audienceType": { "type": "string" }
      }
    }
  }
}