Ga naar inhoud
Methodologie

OpenAPI / API-docs

ia.openapi · 4.5

Handelen ZOU MOETEN Gemeten onderzoek AR-ACT-02

Waarom het belangrijk is

OpenAPI-specificaties laten AI-agents je API begrijpen en aanroepen. AI-codeassistenten en agentframeworks gebruiken OpenAPI om correcte API-calls te maken.

Zo los je het op

Publiceer een OpenAPI 3.x-document op /openapi.json en link het.

  1. Genereer een OpenAPI 3.1-document uit de API-code.

    {
  "openapi": "3.1.0",
  "info": {"title": "Example API", "version": "1.0.0"},
  "paths": {"/api/search": {"get": {"operationId": "search", "summary": "Search items"}}}
}

  2. Lever het op /openapi.json of /.well-known/openapi met HTTP 200.

  3. Link het vanuit de API-catalogus en een service-desc-Link-header.

Controleren

curl -sf https://{domain}/openapi.json | jq -e '.openapi | startswith("3.")'

Verwacht: exitcode 0

Start een nieuwe scan voor dit checkpoint:

isagentready results {domain} --checkpoint ia.openapi
Details Koppeling, levenscyclus en bronnen
AR-koppeling
Volledige match
Bron van het bewijs
agentready.org AR-ACT-02
Rol in de score
Kern
Toegevoegd
2026-08-24
Methodologieversie
2026-10-22

Checkpointdata (JSON)