OpenAPIAuthBridge
in package
OpenAPI認証ブリッジ
OpenAPIスキーマのsecurity定義を読み取り、 認証スキームを判定します。
Table of Contents
Properties
- $schema : OpenApi
Methods
- __construct() : mixed
- getRequiredSchemes() : array<string|int, string>
- 指定されたパスとメソッドに必要な認証スキームを取得
- getSchemeDetails() : array{type: string, scheme?: string, in?: string, name?: string}|null
- スキームの詳細情報を取得
- requiresAuthentication() : bool
- 認証が必要かどうか
Properties
$schema
private
OpenApi
$schema
Methods
__construct()
public
__construct(OpenApi $schema) : mixed
Parameters
- $schema : OpenApi
getRequiredSchemes()
指定されたパスとメソッドに必要な認証スキームを取得
public
getRequiredSchemes(string $path, string $method) : array<string|int, string>
Parameters
- $path : string
-
OpenAPIパス (例: /users/{id})
- $method : string
-
HTTPメソッド (例: get, post)
Return values
array<string|int, string> —認証スキーム名の配列 (例: ['bearerAuth', 'sessionAuth'])
getSchemeDetails()
スキームの詳細情報を取得
public
getSchemeDetails(string $schemeName) : array{type: string, scheme?: string, in?: string, name?: string}|null
Parameters
- $schemeName : string
-
スキーム名
Return values
array{type: string, scheme?: string, in?: string, name?: string}|null —スキーム詳細
requiresAuthentication()
認証が必要かどうか
public
requiresAuthentication(string $path, string $method) : bool
Parameters
- $path : string
-
OpenAPIパス
- $method : string
-
HTTPメソッド
Return values
bool —認証が必要な場合true