API Catalog (RFC 9727)

Waarom het belangrijk is

Een API Catalog (RFC 9727 met een RFC 9264-linkset) geeft agents een discoverypunt voor alle API's van de site. Het linkt naar OpenAPI-documenten, docs en health-endpoints.

Zo los je het op

Lever /.well-known/api-catalog als application/linkset+json-document.

1. Maak een linkset met een entry per API en links voor service-desc, service-doc en status.

   {
     "linkset": [{
       "anchor": "https://example.com/api/v1",
       "service-desc": [{"href": "https://example.com/openapi.json", "type": "application/openapi+json"}],
       "service-doc": [{"href": "https://example.com/docs", "type": "text/html"}]
     }]
   }

2. Lever het op /.well-known/api-catalog met Content-Type application/linkset+json.

Controleren

Start een nieuwe scan voor dit checkpoint: