스크램블을 사용하여 Laravel의 API 인증을 문서화합니다

이 튜토리얼은 최신 API 문서 도구 인 Scramble을 사용한 일반적인 Laravel API 인증 방법과 해당 문서를 보여줍니다. 스크램블은 OpenAPI 3.1.0 보안 사양을 완전히 지원하여 포괄적 인 인증 방법 문서를 활성화합니다. 성소 인증

인기있는 Laravel 인증 방법 인 Sanctum은 무국적 및 상태 인증을 모두 지원합니다. 상태가없는 인증을 위해,

헤더 : 에 소지자 토큰이 전송됩니다. 스크램블은 서비스 제공 업체의

메소드를 사용하여 이것을 문서화합니다

Authorization 이것은 모든 엔드 포인트에 대한 기본 베어러 토큰 보안 체계를 설정합니다. Stateful Authentication Scramble의 문서 경로가 올바르게 구성된 경우 "Try It Out"기능 내에서 자동으로 작동합니다. 여권 인증 Authorization: Bearer *** OAUTH2 인증의 경우 OpenApi는 boot 보안 체계를 사용합니다. 스크램블은 정확한 구성을 허용합니다

스코프는 전 세계적으로 또는 세분화 된 제어로 정의 될 수 있습니다. 정지등 요소 (Scramble의 기본 UI)는 요구 사항을 표시하지만 다른 UI (Scalar, Swagger)는 문서에서 직접 토큰 획득을 촉진합니다.

use Dedoc\Scramble\Scramble;
use Dedoc\Scramble\Support\Generator\OpenApi;
use Dedoc\Scramble\Support\Generator\SecurityScheme;

public function boot()
{
    Scramble::configure()
        ->withDocumentTransformers(function (OpenApi $openApi) {
            $openApi->secure(
                SecurityScheme::http('bearer')
            );
        });
}

성소의 종점 성소를 문서화하는 엔드 포인트는 커뮤니티가 기부 한 스크램블 확장으로 달성 할 수 있습니다. Scramble의 문서화 가능한 경로에 포함시켜야합니다

사용자 정의 인증

다중 헤더 인증 여러 헤더가 필요한 인증의 경우 API 보안 요구 사항 내에 지정하십시오.

이것은 와

헤더 모두를 의무화합니다 쿼리 매개 변수의 API 토큰 oauth2 API 토큰이 쿼리 매개 변수 인 경우 : 를 사용하십시오

더 많은 보안 제도 세부 사항에 대한 Scramble의 문서를 참조하십시오. 인증에서 경로를 제외하고 use Dedoc\Scramble\Scramble; use Dedoc\Scramble\Support\Generator\OpenApi; use Dedoc\Scramble\Support\Generator\SecurityScheme; use Dedoc\Scramble\Support\Generator\SecuritySchemes\OAuthFlow; public function boot() { Scramble::configure() ->withDocumentTransformers(function (OpenApi $openApi) { $openApi->secure( SecurityScheme::oauth2() ->flow('authorizationCode', function (OAuthFlow $flow) { $flow ->authorizationUrl(config('app.url').'/oauth/authorize') ->tokenUrl(config('app.url').'/oauth/token') ->addScope('*', 'all'); }) ); }); }

Phpdoc 주석은 인증에서 경로를 제외합니다. 작동 변압기는 더 많은 유연성을 제공합니다. 예를 들어, oauth2 미들웨어가없는 노선을 면제합니다

use Dedoc\Scramble\Scramble;
use Dedoc\Scramble\Support\Generator\OpenApi;
use Dedoc\Scramble\Support\Generator\SecurityScheme;

public function boot()
{
    Scramble::configure()
        ->withDocumentTransformers(function (OpenApi $openApi) {
            $openApi->secure(
                SecurityScheme::http('bearer')
            );
        });
}

이것은 인증 미들웨어가없는 경로를 공개로 자동으로 지정합니다. 이 접근법은 또한 특정 보안 요구 사항을 운영에 할당 할 수 있습니다.

결론 OpenApi 및 Scramble은 미들웨어를 기반으로 자동 처리, 수동 주석 최소화를 포함한 다양한 API 인증 방법을 문서화하기위한 강력한 솔루션을 제공합니다. https://www.php.cn/link/0fcbc3c0cf262c771001001930af2406bbc

위 내용은 스크램블을 사용하여 Laravel의 API 인증을 문서화합니다의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!