SwiftSchemaGenerate
    Schema stack

    API Reference Stack

    API reference pages that combine TechArticle narrative with WebAPI context, FAQs, and breadcrumb navigation.

    Open generatorValidate in Rich Results Test
    Included schema
    Tech Article
    Web API
    Frequently Asked Questions
    Breadcrumb
    Fit

    When to use this stack

    • Endpoint reference pages for REST/GraphQL APIs
    • API reference hubs that need a clear WebAPI object plus documentation link
    • Docs where FAQs clarify auth, rate limits, and versioning
    Composition

    What is included

    • Tech Article

      Captures the page-level reference article with authorship and dates.

    • Web API

      Defines the API being documented, including endpoint base URL and provider.

    • Frequently Asked Questions

      Answers common integration questions (auth, limits, versioning, errors).

    • Breadcrumb

      Provides navigation context within the docs hierarchy.

    Data contract

    Properties across the bundle

    Nested properties keep their parent path, such as offers.priceCurrency. Only publish values that match visible page content.

    Required properties

    • author.name
    • datePublished
    • description
    • documentation
    • endpointUrl
    • headline
    • itemListElement[].name
    • mainEntityOfPage
    • mainEntity[].@type=Question
    • mainEntity[].acceptedAnswer.text
    • name
    • provider.name

    Recommended properties

    • about.@id
    • audience.audienceType
    • dateModified
    • description
    • inLanguage
    • itemListElement[].item
    • mainEntity[].acceptedAnswer.text
    • mainEntity[].author.name
    • mainEntity[].name
    • termsOfService
    • version
    Copy-ready example

    Combined JSON-LD

    Paste this as one script tag, then replace every example value with data from the live page.

    Validate
    [
  {
    "@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" }
    ]
  }
]
    Workflow

    Implement and verify

    1. 01

      Start with the live page

      Confirm titles, prices, availability, policies, and visible FAQ content before generating markup.

    2. 02

      Add one JSON-LD script

      Use the combined example as a template in the document head or before the closing body tag.

    3. 03

      Complete regional details

      Fill shipping destinations and timing for every region the page actually serves.

    4. 04

      Link the return policy

      Use a stable MerchantReturnPolicy URL and keep its terms synchronized with the page.

    5. 05

      Match visible answers

      Add only FAQs that users can read on the same page, with identical answers.

    6. 06

      Validate after changes

      Run Rich Results Test after implementation and whenever price, availability, or policy data changes.

    Quality check

    Common errors and fixes

    • Missing currency or availability

      Use ISO currency codes and complete schema.org availability URLs in Offer data.

    • Incomplete shipping details

      Include shippingDestination.addressCountry and deliveryTime.transitTime with units.

    • Return policy is not connected

      Reference MerchantReturnPolicy from the Offer and provide a stable public policy URL.

    • FAQ answers differ from the page

      Keep structured FAQ answers identical to visible answers.

    Questions

    Stack FAQs

    Do I need both TechArticle and WebAPI?

    Yes. TechArticle represents the page content, while WebAPI represents the API itself and can be reused across endpoints.

    Where should I put endpoint examples?

    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.

    Primary sources

    References