如何用爭奪記錄Laravel中的多個API

laravel應用程序通常管理多個API，有益於版本，分離公共和內部訪問或滿足不同的前端/後端需求。 爭奪簡化了記錄這些不同的API。

>

> cramble的默認設置文檔是“默認” API，涵蓋了以api/開頭的端點。 添加更多的API涉及註冊，配置和文檔曝光。

>

>>示例：記錄多個API版本

>

考慮一個具有兩個API版本的應用程序：

>

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

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

要記錄v1，調整爭奪config：

// config/scramble.php
...
'api_path' => 'api/v1',
...

對於v2>，請在服務提供商的boot方法中明確註冊：

>

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

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

註冊v2的文檔路由routes/web.php>：

>

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

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

現在，兩個API都記錄在案：>

• v1文檔：

  • ：ui for V1文檔GET docs/api
  • ：openapi 3.1.0 V1GET docs/api.json>的規範

• v2文檔：

  • ：ui for V2文檔GET docs/v2
  • ：openapi 3.1.0 V2GET docs/v2/api.json的規範

控製文檔訪問

對於公共和私人API，管理中間件。 默認情況下，文檔僅限於非生產環境。

公開RestrictedDocsAccess，請從默認配置中刪除

v1限制RestrictedDocsAccess

非生產：

// config/scramble.php
...
'middleware' => [
    'web',
],
...

v2現在，

在生產中可以公開訪問，而

// app/Providers/AppServiceProvider.php
use Dedoc\Scramble\Http\Middleware\RestrictedDocsAccess;

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

仍然僅限於非生產。

> v1v2>自定義V1文檔路由

自定義默認路由（

，

），禁用默認路由註冊：v1 GET docs/api 然後，手動註冊它們：GET docs/api.json

// app/Providers/AppServiceProvider.php
public function register()
{
    Scramble::disableDefaultRoutes();
}

結論

// routes/web.php
Scramble::registerUiRoute('docs/v1', api: 'default');
Scramble::registerJsonSpecificationRoute('docs/v1/api.json', api: 'default');

在單個Laravel應用程序中，有效地處理多個API文檔，為每個API提供對路線，中間件和配置的顆粒狀控制。 在以下網址了解更多信息：

https://www.php.cn/link/0fcbc3c3c0cf262c771001930af2406bbbc

以上是如何用爭奪記錄Laravel中的多個API的詳細內容。更多資訊請關注PHP中文網其他相關文章！