JWT Authentication

[johannesschobel]

Dear @mpociot and others,

I am using JWT Authentication (see this package in order to secure my API. However, when generating the API Documentation using your package, the request and response for these routes are empty (or null).

I try running the --actAsUserId=1 parameter as well - didn`t change anything. Could it be, because my JWT plugin requires atoken parameter? Or am I (again) missing something out?

Thanks you very much in advance ;)

[climbingblake]

Im using the same pkg, but without issues on the request. possible that your requests are not setup correctly?

as for response, It may be an issue with the transformers as others have suggested, mine is also blank.

back to the JWT, im also trying to find a way for the Bearer and Content-Type to be included in the request examples.

[mpociot]

@climbingblake Regarding the response issue: Have you tried the latest version? It has a lot of improvements.

For example is it now possible to modify the generated route description without losing the data when regenerating your documentation.

Probably the easiest way to add your custom Headers into the documentation is by publishing the vendor files using php artisan vendor:publish and then modify the generation templates to suit your needs.

[shez1983]

but how do we authenticate ie when making the calls:

php artisan api:generate --routePrefix=api/* I get a 500 as I need to provide an authToken with the requests?

[mpociot]

It's now possible to add custom HTTP headers to API routes using the --header option.

For example:

php artisan api:generate --routePrefix="api/*" --header 'Authorization: MyCustomToken' --header 'X-Custom-Header: foobar'

[c00p3r]

OK
Here's what I investigated
when calling command like this
php artisan api:generate --router="dingo" --routePrefix="v1" --actAsUserId=1 --header="Authorization : Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImlzcyI6Imh0dHA6Ly9pbXVzaWZ5LmxhcmEubG9jL2FwaS9hdXRoZW50aWNhdGUiLCJpYXQiOjE0OTczNzEzNDYsImV4cCI6MTQ5NzM3NDk0NiwibmJmIjoxNDk3MzcxMzQ2LCJqdGkiOiJKeWlITWhvODZLcHVOZE1kIn0.mTNK1HO8b39QOrRBWlKfP5xxhLA2s_7RGgNiO4vD1so"
I went to /Mpociot/ApiDoc/Generators/DingoGenerator.php method processRoute line 24 and dumped the exception here like this

try {
    $response = $this->getRouteResponse($route, $bindings, $headers);
} catch (Exception $e) {
    dump($e);
}

And gues what?!
I get Exception on EVERY call !!!

Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException {#2074
  -statusCode: 401
  -headers: array:1 [
    "WWW-Authenticate" => null
  ]
  #message: "Failed to authenticate because of bad credentials or an invalid authorization header."

If someone interested I attached stack_trace.txt here

Please someone tell how to fix or bypass this