Skip to content

Proofread jwt #334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Nov 10, 2017
Merged

Proofread jwt #334

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
36ed5a0
Spell words properly
Nov 8, 2017
310d89f
Remove trailing spaces
Nov 8, 2017
cc3ec8c
Improve style
Nov 8, 2017
5f17feb
Quote button label
Nov 8, 2017
f888611
Remove extra word
Nov 8, 2017
8865c27
Improve formatting
Nov 8, 2017
f10acc5
Add punctuation
Nov 8, 2017
1f4ec32
Use "an" instead of "a"
Nov 8, 2017
b911f48
Fix grammar
greg0ire Nov 8, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions core/jwt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,11 @@ security:
- { path: ^/login, role: IS_AUTHENTICATED_ANONYMOUSLY }
- { path: ^/books, roles: [ ROLE_READER ] }
- { path: ^/, roles: [ ROLE_READER ] }
```
```

## Documenting the Authentication Mechanism with Swagger/Open API

You want to test the routes of your API protected by JWT authentication?
Want to test the routes of your JWT-authentication-protected API?

### Configuring API Platform

Expand All @@ -74,14 +74,14 @@ api_platform:
- { name: 'Authorization', type: 'header' }
```

And the Authorize button will automatically appear in Swagger UI.
And the "Authorize" button will automatically appear in Swagger UI.

![Screenshot of API Platform with Authorize button](images/JWTAuthorizeButton.png)

### Adding a New API Key

All you have to do is to configure the API key in the value field.
By default [only the authorization header mode is enabled](https://github.com/lexik/LexikJWTAuthenticationBundle/blob/master/Resources/doc/index.md#2-use-the-token) in [LexikJWTAuthenticationBundle](https://github.com/lexik/LexikJWTAuthenticationBundle).
All you have to do is configuring the API key in the `value` field.
By default, [only the authorization header mode is enabled](https://github.com/lexik/LexikJWTAuthenticationBundle/blob/master/Resources/doc/index.md#2-use-the-token) in [LexikJWTAuthenticationBundle](https://github.com/lexik/LexikJWTAuthenticationBundle).
You must set the [JWT token](https://github.com/lexik/LexikJWTAuthenticationBundle/blob/master/Resources/doc/index.md#1-obtain-the-token) as below and click on the "Authorize" button.

```
Expand All @@ -93,7 +93,7 @@ Bearer MY_NEW_TOKEN

## Testing with Behat

Let's configure Behat to automatically send a `Authorization` HTTP header containing a valid JWT token when a scenario is marked with a `@login` annotation. Edit `features/bootstrap/FeatureContext.php` and add the following methods:
Let's configure Behat to automatically send an `Authorization` HTTP header containing a valid JWT token when a scenario is marked with a `@login` annotation. Edit `features/bootstrap/FeatureContext.php` and add the following methods:

```php
<?php
Expand All @@ -106,7 +106,7 @@ use Behatch\Context\RestContext;
class FeatureContext implements Context, SnippetAcceptingContext
{
// ...
// Must be aster createDatabase() and dropDatabase() functions (the order matters)
// Must be after createDatabase() and dropDatabase() functions (the order matters)

/**
* @BeforeScenario
Expand Down Expand Up @@ -156,7 +156,7 @@ default:
# ...
```

Finally, mark your scenarios with the `@login` annotation to automatically add a valid `Authorization` header and with `@logout` to be sure to detroy the token after this scerario.
Finally, mark your scenarios with the `@login` annotation to automatically add a valid `Authorization` header, and with `@logout` to be sure to destroy the token after this scenario.

Previous chapter: [FOSUserBundle Integration](fosuser-bundle.md)

Expand Down