Ga naar inhoud
Methodologie

Link-responseheaders

ia.link-headers · 1.9

Vinden MAG Aanbeveling AR-FIND-04 AR-READ-06

Waarom het belangrijk is

RFC 8288 Link-headers laten een bestaande API naar machineleesbare beschrijvingen en documentatie verwijzen. Dit checkpoint maakt zelf geen API-toepasbaarheid.

Zo los je het op

Verwijs met een RFC 8288 Link-header naar je API-catalogus, servicebeschrijving of documentatie.

  1. Voeg aan de response van de homepage een Link-header toe die naar je API-beschrijving verwijst.

    Link: </.well-known/api-catalog>; rel="api-catalog", </openapi.json>; rel="service-desc"
  2. Zorg dat elke gelinkte resource HTTP 200 geeft.

Controleren

curl -sI https://{domain}/

Verwacht: Een Link-header met rel api-catalog, service-desc of service-doc

Start een nieuwe scan voor dit checkpoint:

isagentready results {domain} --checkpoint ia.link-headers
Details Koppeling, levenscyclus en bronnen