Add Exception configuration documentation #173
Conversation
core/exceptions.md
Outdated
| @@ -0,0 +1,94 @@ | |||
| # Exceptions | |||
There was a problem hiding this comment.
I would rename this entry "Error Handling" (errors.md).
core/exceptions.md
Outdated
| @@ -0,0 +1,94 @@ | |||
| # Exceptions | |||
|
|
|||
| API Platform Core allows you to customize the HTTP status code sent after an exception is thrown. | |||
There was a problem hiding this comment.
API Platform Core allows to customize HTTP status codes sent to clients when exceptions are thrown.
core/exceptions.md
Outdated
|
|
||
| API Platform Core allows you to customize the HTTP status code sent after an exception is thrown. | ||
|
|
||
| ## configuration |
core/exceptions.md
Outdated
|
|
||
| ## configuration | ||
|
|
||
| ```YAML |
core/exceptions.md
Outdated
| # ... | ||
|
|
||
| exception_to_status: | ||
| # By default there are two exceptions defined that you can customize. |
There was a problem hiding this comment.
# app/config/config.yml
services:
# Map exceptions to HTTP status codes using the `exception_to_status` configuration key
exception_to_status:
# The 2 following exceptions are handled by default
Symfony\Component\Serializer\Exception\ExceptionInterface: 400 # Use a raw status code (recommended)
ApiPlatform\Core\Exception\InvalidArgumentException: 'HTTP_BAD_REQUEST' # Or with a constant of `Symfony\Component\HttpFoundation\Response`
AppBundle\Exception\MyException: 401 # Custom exceptions can easily be handled
core/exceptions.md
Outdated
|
|
||
| As in any php application, your exceptions have to extends the \Exception class or any of it's children. | ||
|
|
||
| ```PHP |
core/exceptions.md
Outdated
| */ | ||
| class CartManager | ||
| { | ||
| const NOTFOUND_DOESNOTEXISTS = 51; |
There was a problem hiding this comment.
I would strip the NOTFOUND prefix and a visibility to all those constants.
core/exceptions.md
Outdated
| * | ||
| * @return Product $product | ||
| */ | ||
| public function addProductToCart($id) |
There was a problem hiding this comment.
public function addProductToCart(int $id)
core/exceptions.md
Outdated
| const NOTFOUND_OUTOFSTOCK = 53; | ||
|
|
||
| /** | ||
| * @param integer $id |
core/exceptions.md
Outdated
|
|
||
| /*...*/ | ||
|
|
||
| return $cart; |
There was a problem hiding this comment.
I would return nothing (CQRS like)
core/exceptions.md
Outdated
| throw new ProductNotFoundException(self::NOTFOUND_OUTOFSTOCK); | ||
| } | ||
|
|
||
| /*...*/ |
|
I would merge both sections (the last section should be an example illustrating the config). I propose to start with the tiny exception example (it can simplified IMO, and it should be more integrated with API Platform, for instance used as an event listener). |
|
By the way it would be nice to show that API Platform automatically handle validation errors (it can be another section) |
core/exceptions.md
Outdated
| } | ||
| ``` | ||
|
|
||
| It doesn't have to be an HttpException, any type of Exception can be thrown. The best part is that API Platform already takes care of how the error is handled and returned. If you configured your API to respond in a JsonLD format, your error will be returned in JsonLD format as well. |
There was a problem hiding this comment.
The exception doesn't have to be a Symfony's `HttpException`. Any type of `Exception` can be thrown. The best part is that API Platform already takes care of how the error is handled and returned. For instance the API is configured to respond in JSON-LD, the error will be returned in this format as well.
|
I'll do the example for validation errors and transform the exception example as an event listener tomorrow. |
|
Ok I made some changes, but I am not really convinced that it is what you had in mind. |
No description provided.