We use cookies for analytics and to serve ads. Accept to enable Google Analytics and AdSense. You can decline to stay opt-out.
API reference pages that combine TechArticle narrative with WebAPI context, FAQs, and breadcrumb navigation.
Captures the page-level reference article with authorship and dates.
Defines the API being documented, including endpoint base URL and provider.
Answers common integration questions (auth, limits, versioning, errors).
Provides navigation context within the docs hierarchy.
Ensure every applicable required property is present in your implementation. Nested props reference their parent objects (for example, `offers.priceCurrency`).
Paste as a single script tag. Keep product details, offer data, shipping/returns, and FAQ answers in sync with the page.
[
{
"@context": "https://schema.org",
"@type": "TechArticle",
"@id": "https://www.example.com/docs/payments-api#article",
"headline": "Payments API Reference",
"description": "Use the Payments API to create charges, capture funds, issue refunds, and manage webhooks.",
"datePublished": "2024-10-01",
"dateModified": "2025-01-15",
"inLanguage": "en",
"author": { "@type": "Organization", "name": "Example Pay" },
"mainEntityOfPage": "https://www.example.com/docs/payments-api",
"about": { "@id": "https://www.example.com/docs/payments-api#webapi" }
},
{
"@context": "https://schema.org",
"@type": "WebAPI",
"@id": "https://www.example.com/docs/payments-api#webapi",
"name": "Payments API v2",
"description": "RESTful API for payments, refunds, webhooks, and payouts.",
"version": "2.1",
"provider": { "@type": "Organization", "name": "Example Pay", "url": "https://www.example.com" },
"endpointUrl": "https://api.example.com/v2",
"documentation": "https://www.example.com/docs/payments-api",
"termsOfService": "https://www.example.com/legal/terms",
"audience": { "@type": "Audience", "audienceType": "Developers" }
},
{
"@context": "https://schema.org",
"@type": "FAQPage",
"mainEntity": [
{
"@type": "Question",
"name": "How do I authenticate requests?",
"acceptedAnswer": {
"@type": "Answer",
"text": "Send your secret API key in the Authorization header using the Bearer scheme. Rotate keys regularly from your dashboard."
}
},
{
"@type": "Question",
"name": "What are the rate limits?",
"acceptedAnswer": {
"@type": "Answer",
"text": "The default limit is 200 requests per minute per account. We return standard rate-limit headers so you can back off gracefully."
}
},
{
"@type": "Question",
"name": "How do you version the API?",
"acceptedAnswer": {
"@type": "Answer",
"text": "We version breaking changes via the URL (e.g., /v2). Use the latest stable version and review changelog notes before upgrading."
}
}
]
},
{
"@context": "https://schema.org",
"@type": "BreadcrumbList",
"itemListElement": [
{ "@type": "ListItem", "position": 1, "name": "Home", "item": "https://www.example.com" },
{ "@type": "ListItem", "position": 2, "name": "Docs", "item": "https://www.example.com/docs" },
{ "@type": "ListItem", "position": 3, "name": "Payments API", "item": "https://www.example.com/docs/payments-api" }
]
}
]Yes. TechArticle represents the page content, while WebAPI represents the API itself and can be reused across endpoints.
Keep request/response samples in the visible page and reference them in the TechArticle body; the WebAPI object should cover base URL, version, and provider.