Générer de la documentation API dans Laravel/lumen sans utiliser d'annotations : un guide étape par étape

Question

Je ne peux pas générer de documentation API dans Laravel/lumen via Composer nécessite Rakutentech/Laravel-request-docs --dev.

Existe-t-il un outil pour générer automatiquement de la documentation dans Laravel/lumen.

Answer 1

Tout d'abord, il n'y a pas de commande 供应商：在流明中发布。您可以使用 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

Il existe de nombreuses solutions de contournement que vous pouvez utiliser, telles que :

• Utilisez simplement Laravel

  C'est le moyen le plus simple et le plus fiable d'installer Rakutentech/Laravel-request-docs. Lumen est un framework léger et il faut s'attendre à ce qu'il ne dispose pas des fonctionnalités disponibles dans Laravel.

• Installer un autre package

  Vous pouvez effectuer une recherche sur packagist et trouver au moins deux alternatives. L'un siège depuis 2 ans, mr-bug-miner/lumen -doc。另一种是 davmixcool/lumen-apidoc-generator siège depuis 4 ans. Aucun des deux packages ne semble prometteur, mais vous pouvez toujours l'essayer.

• Installer le package de compatibilité

  Sur une autre question, quelqu'un a demandé pourquoi il ne pouvait pas publier zizaco/entrust packge。已得到答复，解决方案是使用 irazasyed/larasupport. Il existe d’autres alternatives, alors faites votre choix.

• Ajoutez vos propres conseils de « compatibilité »

  C'est le plus gênant, Je ne suis pas d'accord avec ça. Vous pouvez ajouter VendorPublishCommand.php 复制到 app/Console/Commands 中，看看它是否有效。不过，我相信您需要稍微删除原始代码 - 特别是 VendorTagPublished événements.

---

Ce sera plus facile pour vous si vous avez déjà commencé votre recherche à partir du message d'erreur.

Aussi, un petit conseil, évitez généralement de demander des ressources hors site. Soyez prudent lorsque vous demandez un forfait alternatif.