Réponse 500

Par défaut, Okapi surcharge la réponse de l'API lorsque cette dernière retourne un code 500.

Par défaut les frameworks applicatifs ont tendances à fournir des informations sur l'origine de l'erreur ce qui peut divulguer des informations sur la stack technique et permettre à un potentiel attaquant de cibler des failles.

Cependant, certaines API qui gèrent correctement leurs erreurs peuvent retourner des informations pour aider au support. C'est pourquoi vous avez la possibilité de désactiver ce fonctionnement.

Principe de mise en œuvre

Par défaut, Okapi retourne :

{
    "code": "API_INTERNAL_ERROR",
    "message": "Internal Error: contact the API provider"
}

Pour désactiver ce comportement, et avoir le retour de l'API, il faut ajouter la clé forwardApiInternalErrors à true:

api:
  name: My Api
  urlContext: myapi
  version: 1
  extra:
    forwardApiInternalErrors: true
  ...

La valeur peut être mise à false pour qu'Okapi surcharge à nouveau la réponse.