Skip to content

Commit 600b3b1

Browse files
dbuOskarStark
andcommitted
hint for mapping request payload error messages
Co-authored-by: Oskar Stark <oskarstark@googlemail.com>
1 parent 1659563 commit 600b3b1

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

controller.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -502,6 +502,14 @@ payload formats::
502502
// ...
503503
}
504504

505+
.. tip::
506+
507+
If you build a JSON API, make sure to declare your route as using the JSON
508+
:ref:`format <routing-format-parameter>`. This will make the error handling
509+
output a JSON response in case of validation errors, rather than an HTML page::
510+
511+
#[Route('/dashboard', name: 'dashboard', format: 'json')]
512+
505513
Make sure to install `phpstan/phpdoc-parser`_ and `phpdocumentor/type-resolver`_
506514
if you want to map a nested array of specific DTOs::
507515

0 commit comments

Comments
 (0)