This repository has been archived by the owner on Jan 29, 2020. It is now read-only.
Being able to determine if only json or xml should be handled, instead of both. #49
Open
2 tasks done
I have run into this use case:
My application has a JSON API which is served under the
/rest
path, but also 3 or 4 more routes which are not part of this API context.For the API I use "problem details" for the errors, but I also have some other error handling logic for the other routes.
Because of this, my middleware pipeline looks more or less like this:
With this approach, most of the use cases work as expected, except when a request is performed to a not-found path which starts with
/rest
, proividing a non-JSONAccept
header, but one that matches*+xml
.This usually happens when a request is performed from a browser, in which case the
Accept
has the valuetext/html,application/xhtml+xml,application/xml
...This is making the
ProblemDetailsNotFoundHandler
to generate an xml response, but I would expect/like it to be skipped and my customNotFoundHandler
(the second one) to be executed instead.Proposal
In order to "solve" this, the first thing that comes to my mind is this approach:
Allowing to dynamically determine which "contexts" should be enabled for the module, as in "JSON only", "XML only" or "both".
I see that currently, the headers that determine if the
ProblemDetailsMiddleware
and theProblemDetailsNotFoundHandler
should act as error handlers, are hardcoded onProblemDetailsResponseFactory::NEGOTIATION_PRIORITIES
.Since the three classes make use of that constant to call a
Negotiator
instance, maybe the whole logic could be wrapped into a helper which is injected in the three of them.This helper could then get the "context" configuration or fallback to "both", keeping current behavior.
Let me know if you think this makes sense, or if you think there's any simpler way to achieve the same result.
In any case, I'm open to contribute a PR with the required changes.
The text was updated successfully, but these errors were encountered: