Skip to content

Conversation

@ybelenko
Copy link
Contributor

@ybelenko ybelenko commented Jun 4, 2020

It's a bad practice to use general PHP Exception because it makes difficult to catch specific cases. Slim framework contains Slim\Exception\HttpNotImplementedException class which looks better than unknown Exception.

Result of API call with header Accept: application/json and displayErrorDetails: false option:
HTTP/1.1 501 Not Implemented

{
  "message": "501 Not Implemented"
}

and with displayErrorDetails: true option:
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:

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./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.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc @jebentier @dkarlovi @mandrean @jfastnacht @ackintosh @renepardon

@OpenAPITools OpenAPITools deleted a comment from auto-labeler bot Jun 4, 2020
@ybelenko ybelenko force-pushed the slim4_notimplemented_exception branch from 19ce7ce to 65bc976 Compare June 4, 2020 16:45
ybelenko added 2 commits June 7, 2020 15:00
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.
@ybelenko ybelenko force-pushed the slim4_notimplemented_exception branch from 65bc976 to b1f3c63 Compare June 7, 2020 12:00
@ybelenko ybelenko added this to the 5.0.0 milestone Jun 7, 2020
Copy link
Member

@wing328 wing328 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@wing328 wing328 merged commit 90f904a into OpenAPITools:master Jun 14, 2020
@ybelenko ybelenko deleted the slim4_notimplemented_exception branch June 14, 2020 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants