Laravel API 文件生成器生成指定的 API 文件

Liuzhipeng_laravel發表於2019-07-11
LaravelAPI

從現有的Laravel / Lumen / Dingo路線自動生成API文件

--安裝過程就不再這裡說了可以參照github的安裝說明或者Laravel學院同學的文章

重點說一下如何生成自己想要生成的文件部分：

先看一下官方的介紹

  • 該包提取所有應用程式的路由。
  • 它會檢視您的配置檔案，以過濾您實際要記錄的路由。對於每個路徑，它會檢索您要應用於它的設定（如果有）。
  • 它處理每條路線。這裡的“過程”涉及使用多種策略來提取路線的資訊：組，標題，描述，身體引數，查詢引數和樣本響應（如果可能）。
  • 處理完路徑後，它會生成一個markdown檔案，描述來自解析資料的路徑並將它們傳遞給Documentarian，後者將它們包裝在一個主題中並將它們轉換為HTML和CSS。
  • 它為您的路線生成Postman API集合。（可以禁用此功能。）

回到問題再來看
--需要在你的app/apidoc.php中配置如下 

                'prefixes' => [
                    '你的路由檔名稱/*',
                    // 'users/*',
                ],

然後再根目錄執行

php artisan api:generate

即可將你指定的路由檔案下的所有路由生成對應的文件，官方提供的文件很全需要其他配置的同學請仔細閱讀文件，如果我的文章有錯誤歡迎同學踴躍指出。

本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章