Fix guides ยท Emerging standards

Publish an API catalog

Optional, for sites with APIs: serve a Linkset document at /.well-known/api-catalog.

Proposal or draft, no proven ranking benefit

What we check

We fetch /.well-known/api-catalog and require valid JSON with a linkset field. A normal HTML page returned with a 200 doesn't count.

3%

of 198 sites we could read pass this.

Why it matters

RFC 9727 is a Proposed Standard for helping clients discover a publisher's APIs. It requires the application/linkset+json format.

It's only relevant if you publish APIs.

How to fix it

  1. List your APIs in Linkset format.
  2. Serve it at the well-known path with the right media type.
{
  "linkset": [
    {
      "anchor": "https://api.yoursite.com/",
      "service-desc": [{"href": "https://api.yoursite.com/openapi.json"}]
    }
  ]
}

Fix it yourself with AI

Small fixes shouldn't sit in a queue. Give your AI agent one prompt, and it fixes and deploys for you.

PromptShip is made by the team behind this checker.

Sources

Fixed it?

Run your site through the checker, and re-check after you ship to see what improved.

Check my site

Related guides