Skip to content

Commit 3d36f90

Browse files
committed
Update authentication.md
1 parent 80899cd commit 3d36f90

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

Resources/doc/authentication.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,17 @@ Swagger UI Bundle
1616
realm: "your-realms"
1717
```
1818

19-
Coupled with the correct OAuth authentication definition in your API declarations,
19+
Coupled with the correct OAuth authentication definition in the Swagger API declarations, an OAuth authentication flow will be presented in the documentation.
20+
21+
### HTTP
22+
```
23+
al_swagger_ui:
24+
http:
25+
enable: true
26+
key_name: __key
27+
delivery: query
28+
```
29+
30+
This will add an API key field in the documentation page. `delivery` can be set to either `query` or `header`, whichever is applicable to your API authentication protocol.
31+
32+
__Note that both of these authentication methods can be enabled at the same time.__

0 commit comments

Comments
 (0)