API 目录发现

Fern 文档站点实现了 RFC 9727，让 AI 代理、MCP 客户端和 API 目录爬虫无需抓取 HTML 即可发现您的 API。该目录会根据可见的 API 参考 导航自动生成，并通过每个页面的 Link 响应头公布——无需任何配置。通过 hidden: true 隐藏的引用（或所有端点都被隐藏的引用）会被排除在外。

您的 API 目录位于 your-documentation-site.com/.well-known/api-catalog。例如，本站的目录位于 buildwithfern.com/learn/.well-known/api-catalog：

$
curl -s https://buildwithfern.com/learn/.well-known/api-catalog | jq .

对于带有 /docs 等基础路径的站点，目录会位于该基础路径下（例如 https://example.com/docs/.well-known/api-catalog）。

响应格式

该端点会返回一个列出每个可见 API 的 Linkset 文档。每条记录包含：

• anchor — 人类可读的 API 参考页面 URL
• service-desc — 机器可读的 OpenAPI 规范
• service-doc — 与 anchor 相同的参考页面

1
{
2
  "linkset": [
3
    {
4
      "anchor": "https://example.docs.com/api-reference",
5
      "service-desc": [
6
        {
7
          "href": "https://example.docs.com/openapi.yaml?api=abc123",
8
          "type": "application/yaml"
9
        }
10
      ],
11
      "service-doc": [
12
        {
13
          "href": "https://example.docs.com/api-reference",
14
          "type": "text/html"
15
        }
16
      ]
17
    }
18
  ]
19
}