如何在 Laravel/lumen 中生成沒有注釋的 API 文檔？

Question

我無法通過 composer require Rakutentech/Laravel-request-docs --dev 在 Laravel/lumen 中生成 API 文檔。

如果有任何工具可用於在 Laravel/lumen 中自動生成文檔。

Answer 1

首先，lumen 中沒有vendor:publish 。 您可以使用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 中可用的功能是可以預料的。

• 安裝另一個 package

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

• 安裝兼容性 package

  在另一個問題上，有人問為什么他們不能發布zizaco/entrust 。 已得到解答，解決方案是使用irazasyed/larasupport 。 還有其他選擇，所以請選擇您的選擇。

• 添加您自己的“兼容性”技巧

  這是最麻煩的，我不贊成它。 例如，您可以將VendorPublishCommand.php復制到app/Console/Commands中，看看它是否有效。 不過，我相信您需要稍微刪除原始代碼——尤其是VendorTagPublished事件。

---

如果您是從錯誤消息開始研究的，那么您會輕松一些。

此外，一些建議，通常是避免尋求異地資源。 每當您要求替代套餐時，請謹慎行事。