Skip to content

Update security.md with Swagger UI instructions #2248

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

Open
RomainMazB wants to merge 1 commit into
base: 4.2
Choose a base branch
from
Open

Update security.md with Swagger UI instructions #2248

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions laravel/security.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,22 @@
],
];
```

If you plan to use Swagger UI to test your API through the browser, also uncomment the `swagger_ui.apiKeys` config to display the Authorization form in Swagger UI:
```php

Check failure on line 106 in laravel/security.md

View workflow job for this annotation

GitHub Actions / Lint

Fenced code blocks should be surrounded by blank lines 

laravel/security.md:106 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```php"] https://github.com/DavidAnson/markdownlint/blob/v0.39.0/doc/md031.md
<?php
// config/api-platform.php
return [
// ....
'swagger_ui' => [
// ....
'apiKeys' => [
'api' => [
'name' => 'Authorization',
'type' => 'header',
],
],
]
];
```

Check failure on line 121 in laravel/security.md

View workflow job for this annotation

GitHub Actions / Lint

Fenced code blocks should be surrounded by blank lines 

laravel/security.md:121 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.39.0/doc/md031.md
<img width="898" height="722" alt="image" src="https://github.com/user-attachments/assets/a8ac68ec-e02c-4c49-a2b0-c8dd633ad707" />
Loading