스크램블과 함께 Laravel에서 여러 API를 문서화하는 방법

Laravel 애플리케이션은 종종 여러 API를 관리하고 버전 작성, 공개 및 내부 액세스를 분리하거나 다양한 프론트 엔드/백엔드 요구에 맞게 제공하는 데 유리합니다. 스크램블은 이러한 다양한 API를 문서화하는 것을 단순화합니다 Scramble의 기본 설정은 "기본"API를 문서화하여 로 시작하는 엔드 포인트를 포함합니다. 더 많은 API를 추가하려면 등록, 구성 및 문서 노출이 포함됩니다 예 : 여러 API 버전을 문서화

두 개의 API 버전이있는 응용 프로그램을 고려하십시오

를 문서화하려면

를 문서화하려면 스크램블 구성을 조정하십시오 api/

의 경우 의 경우 서비스 제공 업체의

메소드 내에 명시 적으로 등록하십시오. 문서 경로를

: 에 등록하십시오

이제 두 API가 모두 문서화되어 있습니다

// routes/api.php
Route::prefix('v1')->group(function () {
    // v1 routes
});

Route::prefix('v2')->group(function () {
    // v2 routes
});

v1 문서 :

v1 : v1 문서 : v1 // config/scramble.php ... 'api_path' => 'api/v1', ...에 대한 OpenApi 3.1.0 사양

v2 boot v2 문서 :

// app/Providers/AppServiceProvider.php
use Dedoc\Scramble\Facades\Scramble;

public function boot()
{
    Scramble::registerApi('v2', ['api_path' => 'api/v2']);
}

: v2 문서 v2에 대한 UI routes/web.php : v2 에 대한 OpenApi 3.1.0 사양

// routes/web.php
use Dedoc\Scramble\Facades\Scramble;

Scramble::registerUiRoute('docs/v2', api: 'v2');
Scramble::registerJsonSpecificationRoute('docs/v2/api.json', api: 'v2');

문서 제어

공공 및 개인 API의 경우 미들웨어를 관리하십시오. 기본적으로 문서는 미들웨어를 통해 비 생산 환경으로 제한됩니다.
• 공개를 공개하려면 기본 구성에서

  를 제거하십시오. 제한을 제한하지 않는 것 :

  이제
  는 생산에서 공개적으로 액세스 할 수있는 반면
  • 는 비 생산으로 제한되어 있습니다. V1 문서화 경로 사용자 정의 GET docs/api
  기본값 loutes (,
  • )를 사용자 정의하려면 기본 경로 등록을 비활성화합니다. GET docs/api.json 그런 다음 수동으로 등록하십시오
  결론
스크램블은 단일 라벨 애플리케이션 내에서 여러 API 문서를 효율적으로 처리하여 각 API에 대한 경로, 미들웨어 및 구성에 대한 세분화 제어를 제공합니다. 자세히 알아보십시오

위 내용은 스크램블과 함께 Laravel에서 여러 API를 문서화하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!