List your APIs in one file

How to do it

Serve it as application/linkset+json with the RFC 9727 profile, anchored at the catalog's own URL. Link each API with item, and its description with service-desc. Answer a HEAD request with a Link header naming the catalog.

Example

HTTP/1.1 200 OK
Content-Type: application/linkset+json; profile="https://www.rfc-editor.org/info/rfc9727"
Link: </.well-known/api-catalog>; rel="api-catalog"

{
  "linkset": [
    {
      "anchor": "https://example.com/.well-known/api-catalog",
      "item": [{ "href": "https://example.com/api/v1" }],
      "describedby": [{ "href": "https://example.com/llms.txt", "type": "text/markdown" }]
    },
    {
      "anchor": "https://example.com/api/v1",
      "service-desc": [{ "href": "https://example.com/api/v1/openapi.json", "type": "application/json" }],
      "service-doc": [{ "href": "https://example.com/docs/api", "type": "text/html" }]
    }
  ]
}

How to check

curl -sI on the catalog shows application/linkset+json and the api-catalog link. Every URL listed in it answers 200.