Data & Research · Situational

APIReference schema — what it does & how to ship it

Short answer

APIReference marks up API endpoint documentation with programmingModel, targetPlatform and executableLibraryName — unlocking structured developer discovery.

What it does

APIReference is a TechArticle subtype for API docs. Carries programmingModel, targetPlatform, assemblyVersion and executableLibraryName. Emit per endpoint page.

SERP / AI benefit

Structured developer discovery in Google's dev-doc SERP surfaces and preferential LLM citation for API queries.

Where to use it

Per-endpoint documentation pages.

JSON-LD example

{
  "@context": "https://schema.org",
  "@type": "APIReference",
  "name": "POST /v1/audit",
  "programmingModel": "REST"
}

Copy, edit for your site, and drop into your page head inside a<script type="application/ld+json">block. Validate with Google's Rich Results Test.

In WBP Omni SEO Pro

Add when the WBP public API docs ship.

Ship APIReference without touching code

Frequently asked

APIReference vs TechArticle?›

APIReference is the more specific subtype for endpoint docs; TechArticle is the general technical article.