Hasilkan dokumentasi API dalam Laravel/lumen tanpa menggunakan anotasi: panduan langkah demi langkah

Question

Saya tidak dapat menjana dokumentasi API dalam Laravel/lumen melalui Composer require Rakutentech/Laravel-request-docs --dev.

Adakah terdapat sebarang alat untuk menjana dokumentasi secara automatik dalam Laravel/lumen.

Answer 1

Pertama sekali, tiada arahan 供应商：在流明中发布。您可以使用 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

Terdapat banyak penyelesaian yang boleh anda gunakan, seperti:

• Hanya guna Laravel

  Ini adalah cara yang paling mudah dan boleh dipercayai untuk memasang Rakutentech/Laravel-request-docs. Lumen ialah rangka kerja yang ringan dan dijangkakan ia tidak mempunyai ciri yang tersedia dalam Laravel.

• Pasang pakej lain

  Anda boleh mencari di pembungkus dan mencari sekurang-kurangnya dua alternatif. Seorang dah duduk 2 tahun, mr-bug-miner/lumen -doc。另一种是 davmixcool/lumen-apidoc-generator dah duduk 4 tahun. Kedua-dua pakej tidak kelihatan menjanjikan - tetapi anda sentiasa boleh mencubanya.

• Pasang pakej keserasian

  Pada soalan lain, seseorang bertanya mengapa mereka tidak dapat menyiarkan zizaco/entrust packge。已得到答复，解决方案是使用 irazasyed/larasupport. Terdapat alternatif lain, jadi pilihlah.

• Tambah petua "keserasian" anda sendiri

  Ini yang paling menyusahkan, Saya tidak bersetuju dengannya. Anda boleh menambah VendorPublishCommand.php 复制到 app/Console/Commands 中，看看它是否有效。不过，我相信您需要稍微删除原始代码 - 特别是 VendorTagPublished acara.

---

Ia akan menjadi lebih mudah untuk anda jika anda telah memulakan penyelidikan anda daripada mesej ralat.

Selain itu, sedikit nasihat, biasanya elakkan meminta sumber luar tapak. Sila berhati-hati apabila anda meminta pakej alternatif.