The error flow is typically used to
produce custom error messages or headers, or set the HTTP status. Another example
would be to use it to log additional information using fit-log()
In your swagger.yaml, point the top-level property x-flat-error to a flow
file:
…
x-flat-error:
flow: error.xml # ⬅ error flow
…In this example, we use error.xml to format a custom error message:
<flow>
<template>
{
"CustomError": {
"Message": {{ $error/message }},
"Info": {{ $error/info }}
}
}
</template>
<set-response-headers>
{
"Status": {{ $error/status }},
"Error-Code": {{ $error/code }}
}
</set-response-headers>
</flow>This will ensure that all errors that trigger the error flow will produce a consistent status, error message and headers.