WebAPI & RESTful Microservice Schema Markup (JSON-LD Blueprint)
Structured data for public REST/GraphQL APIs, microservice endpoints, and developer platforms with OpenAPI documentation, authentication requirements, and SLAs.
Displayed below main page header or above the tool container. • Zero CLS Container
Production JSON-LD Code Block
Embed this structured data block directly into your HTML <head> or framework layout template.
{
"@context": "https://schema.org",
"@type": "WebAPI",
"@id": "https://omniseotools.com/api#service",
"name": "OmniSEO Core Audit & Metadata Extraction WebAPI",
"serviceType": "Technical SEO Analysis & Metadata Inspection API",
"documentation": "https://omniseotools.com/docs/api",
"termsOfService": "https://omniseotools.com/terms",
"provider": {
"@type": "Organization",
"name": "OmniSEO Technologies Inc.",
"url": "https://omniseotools.com"
},
"entryPoint": {
"@type": "EntryPoint",
"urlTemplate": "https://api.omniseotools.com/v1/audit{?url,format}",
"httpMethod": "GET",
"contentType": "application/json"
}
}Typed Properties Specification (7 Fields)
Key Schema.org properties and sub-objects required to qualify for rich snippet treatment in Google Search.
| Property | Expected Type | Status | Description & Example |
|---|---|---|---|
| serviceType | Text | Required | Clear functional classification of the API service (e.g. SEO Analysis API). e.g. Technical SEO Analysis & Metadata Inspection API |
| documentation | URL | Required | Direct link to developer documentation or OpenAPI / Swagger interactive UI. e.g. https://omniseotools.com/docs/api |
| termsOfService | URL | Required | Official API rate limit policies and developer terms of service. e.g. https://omniseotools.com/terms |
| provider | Organization | Required | Corporate or open-source entity operating the API service. e.g. { "@type": "Organization", "name": "OmniSEO Technologies Inc." } |
| entryPoint | EntryPoint | Required | Primary network endpoint, HTTP method, and content encoding. e.g. { "@type": "EntryPoint", "urlTemplate": "..." } |
| name | Text | Required | Official API service name. e.g. OmniSEO Core Audit WebAPI |
| description | Text | Recommended | Summary of API capabilities and payload models. e.g. High-speed client-side and server-side metadata inspection. |
Google Search Console Pitfalls & Critical Warnings
Avoid these 3 common validation traps, parser errors, and algorithmic policy penalties when deploying WebAPI schema.
Missing Machine-Readable documentation Link
Supplying a generic homepage rather than dedicated API reference documentation.
Point documentation to an interactive OpenAPI, Swagger, or Redoc endpoint.
Unspecified serviceType Classification
Leaving serviceType empty prevents categorization in specialized developer search queries.
Provide precise serviceType (e.g. 'Technical SEO Analysis API').
Broken termsOfService URL
Omitting termsOfService or linking to a 404 page.
Ensure termsOfService resolves to a live legal agreement.
Recommended Implementation Scenarios
Related Schema Blueprints
Explore complementary structured data blueprints across the Technical SEO cluster.
REST API Endpoint & Webhook Action Schema (JSON-LD Blueprint)
APIDocumentation & Developer Guide Schema (JSON-LD Blueprint)
DeveloperSDK & Client Library Toolkit Schema (JSON-LD)
SoftwareApplication & SaaS Schema Markup (JSON-LD)
Displayed below main page header or above the tool container. • Zero CLS Container