[php-slim4] Throw specialized HttpNotImplementedException#6544
Merged
wing328 merged 2 commits intoOpenAPITools:masterfrom Jun 14, 2020
Merged
[php-slim4] Throw specialized HttpNotImplementedException#6544wing328 merged 2 commits intoOpenAPITools:masterfrom
wing328 merged 2 commits intoOpenAPITools:masterfrom
Conversation
19ce7ce to
65bc976
Compare
Specialized HttpNotImplementedException from Slim makes possible to distinguish general exceptions from case when implementation isn't complete. This update doesn't change API call results.
65bc976 to
b1f3c63
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
It's a bad practice to use general PHP
Exceptionbecause it makes difficult to catch specific cases. Slim framework contains Slim\Exception\HttpNotImplementedException class which looks better than unknownException.Result of API call with header
Accept: application/jsonanddisplayErrorDetails: falseoption:HTTP/1.1 501 Not Implemented{ "message": "501 Not Implemented" }and with
displayErrorDetails: trueoption:HTTP/1.1 501 Not Implemented{ "message": "501 Not Implemented", "exception": [ { "type": "Slim\\Exception\\HttpNotImplementedException", "code": 501, "message": "How about extending AbstractUserApi by OpenAPIServer\\Api\\UserApi class implementing createUser as a POST method?", "file": "/Users/ybelenko/Sites/openapi-generator/samples/server/petstore/php-slim4/lib/SlimRouter.php", "line": 1349 } ] }If user isn't satisfied with mentioned responses he can:
HttpNotImplementedExceptionand overwrite the result.PR checklist
./bin/(or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run./bin/{LANG}-petstore.sh,./bin/openapi3/{LANG}-petstore.shif updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).master,4.3.x,5.0.x. Default:master.cc @jebentier @dkarlovi @mandrean @jfastnacht @ackintosh @renepardon