You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Resources/doc/authentication.md
+14-1Lines changed: 14 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,4 +16,17 @@ Swagger UI Bundle
16
16
realm: "your-realms"
17
17
```
18
18
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