Generieren Sie eine API-Dokumentation in Laravel/Lumen, ohne Anmerkungen zu verwenden: eine Schritt-für-Schritt-Anleitung

Question

Ich kann keine API-Dokumentation in Laravel/Lumen über Composer generieren, dafür ist Rakutentech/Laravel-request-docs --dev erforderlich.

Gibt es ein Tool zum automatischen Generieren von Dokumentationen in 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 a> 已经坐了 4 年了。这两个软件包看起来都没有前途 - 但您可以随时尝试。

• 安装兼容包

  关于另一个问题，有人问为什么他们不能发布 zizaco/entrust packge。已得到答复，解决方案是使用 irazasyed/larasupport 。还有其他替代方案，因此请选择您的选择。

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

  这是最麻烦的，我不赞同它。您可以将 VendorPublishCommand.php 复制到 app/Console/Commands 中，看看它是否有效。不过，我相信您需要稍微删除原始代码 - 特别是 VendorTagPublished 事件。

---

如果您已经从错误消息开始进行研究，那么您会更轻松。

此外，还有一点建议，通常会避免请求场外资源。每当您要求替代套餐时请务必小心。