注釈を使用せずに Laravel/lumen で API ドキュメントを生成する: ステップバイステップガイド

Question

Composer requireRakutentech/Laravel-request-docs --dev を介して Laravel/lumen で API ドキュメントを生成できません。

Laravel/lumen でドキュメントを自動生成するために利用できるツールはありますか。

Answer 1

まず第一に、# サプライヤーは存在しません: を Lumen に公開します。 php 職人リストを使用して確認すると、vendor コマンドが欠落していることがわかります: リーリー

次のようなさまざまなソリューションを使用できます:

• Laravel を使ってください

  これは、

  Rakutentech/Laravel-request-docs をインストールする最も簡単で信頼性の高い方法です。 Lumen は軽量のフレームワークであり、Laravel で利用できる機能が欠けていることが予想されます。

• 別のパッケージをインストールします

  packageist で検索すると、少なくとも 2 つの代替案が見つかります。そのうちの 1 つは、2 年間そこに座っていた、

  mr-bug-miner/lumen -doc です。もう 1 つは davmixcool/lumen-apidoc-generator で、4 年間放置されています。どちらのパッケージも期待できるものではありませんが、いつでも試すことができます。

• 互換性パッケージをインストールする

  別の質問

  に関して、zizaco/entrust パッケージをリリースできない理由を誰かが尋ねました。答えが得られました。解決策は、irazasyed/larasupport を使用することです。 他の代替手段があるので、お好きなものを選んでください。

• 独自の「互換性」に関するヒントを追加します

  これが一番厄介です、

  私はそれに同意しません

  。 VendorPublishCommand.php を app/Console/Commands にコピーして、機能するかどうかを確認できます。ただし、元のコード、特に VendorTagPublished イベントを少し削除する必要があると思います。

エラー メッセージからすでに調査を開始している場合は、より簡単になります。

---

また、ちょっとしたアドバイスですが、通常はオフサイト リソースのリクエストは避けてください。代替パッケージを要求する場合は常に注意してください。