✍️Define a response
/**
* @OpenApi\Response(statusCode=200, response=App\Models\Example)
* @OpenApi\Response(statusCode=404, response={
* "message": "not found",
* "nrs": [{"issue": "#123"}],
* "metadata": {"node": {"server": "1"}}
* })
*/
public function index(Request $request): JsonResponse
{
try {
// ...
} catch (CustomException $e) {
return response()->json([
'message' => $e->getMessage(),
'issues' => $e->getIssues(),
'metadata' => [
'node' => [
'server' => $request->host(),
]
]
]);
}
}
// ... or
#[OpenApi\Response(statusCode: 404, response: [
'message' => 'not found',
'nrs' => [['issue' => '#123']],
'metadata' => ['node' => ['server' => '1']],
])]
public function index(Request $request): JsonResponse
{
try {
// ...
} catch (CustomException $e) {
return response()->json([
'message => $e->getMessage(),
'issues' => $e->getIssues(),
'metadata' => [
'node' => [
'server-1' => $request->host(),
]
]
]);
}
}Last updated