在 Laravel/lumen 中產生 API 文件而不使用註解：逐步指南

Question

我無法透過 Composer require Rakutentech/Laravel-request-docs --dev 在 Laravel/lumen 中產生 API 文件。

是否有任何工具可用於在 Laravel/lumen 中自動產生文件。

Answer 1

首先，沒有 供應商：在流明中發布。您可以使用 php artisan list 進行檢查，它將顯示它缺少 vendor 命令：

Available commands:
completion           Dump the shell completion script
help                 Display help for a command
list                 List commands
migrate              Run the database migrations
auth
 auth:clear-resets    Flush expired password reset tokens
cache
 cache:clear          Flush the application cache
....
schedule
 schedule:run         Run the scheduled commands
 schedule:work        Start the schedule worker
schema
 schema:dump          Dump the given database schema

您可以使用多種解決方法，例如：

• #只需使用 Laravel

  這是安裝 Rakutentech/Laravel-request-docs 的最簡單且可靠的方法。 Lumen 是一個輕量級框架，它缺乏 Laravel 中可用的功能是可以預料的。

• 安裝另一個軟體包

  您可以在 packagist 上搜尋並找到至少兩個替代方案。一個已經坐了兩年了，mr-bug-miner/lumen -doc。另一種是 davmixcool/lumen-apidoc-generator 已經坐了 4 年了。這兩個軟體包看起來都沒有前途 - 但您可以隨時嘗試。

• 安裝相容套件

  關於另一個問題，有人問為什麼他們不能發布 zizaco/entrust packge。已得到答复，解決方案是使用 irazasyed/larasupport 。還有其他替代方案，因此請選擇您的選擇。

• 新增您自己的「相容性」技巧

  #這是最麻煩的，我不同意它。您可以將 VendorPublishCommand.php 複製到 app/Console/Commands 中，看看它是否有效。不過，我相信您需要稍微刪除原始程式碼 - 特別是 VendorTagPublished 事件。

---

如果您已經從錯誤訊息開始進行研究，那麼您會更輕鬆。

此外，還有一點建議，通常會避免要求場外資源。每當您要求替代套餐時請務必小心。