Laravelでapidocを使う方法を教えます!

Laravel の次のチュートリアルコラムでは、laravel で apidoc を使用する方法を紹介します。

#apidoc 公式ドキュメント: http://apidocjs.com /# params

ステップ 1:

npm install apidoc -g

コマンドを使用して apidoc をインストールします。 ステップ 2: プロジェクトのルート ディレクトリに新しい
apidoc.json
ファイルを作成します。ファイルの内容の形式は次のとおりです: <div class="code" style="position:relative; padding:0px; margin:0px;"><pre class='brush:php;toolbar:false;'>{ &quot;name&quot;: &quot;laravel5 API文档&quot;, &quot;version&quot;: &quot;v1.0&quot;, &quot;description&quot;: &quot;本文档提供laravel5 商品，订单，收货地址，等API文档供嗨聊服务端开发人员作为参考，文档使用RESTfull风格，如有疑问请联系开发者&quot;, &quot;apidoc&quot;: { &quot;title&quot;: &quot;laravel5 API文档&quot;, &quot;url&quot; : &quot;http://http://www.learnlaravel5.com//api&quot; }}</pre><div class="contentsignin">ログイン後にコピー</div></div>図に示すように:

3 つのステップ:

apidoc -i myapp/ -o apidoc/ -t mytemplate/"

<div class="code" style="position:relative; padding:0px; margin:0px;"><pre class='brush:php;toolbar:false;'>其中： -i 表示输入，后面是文件夹路径-o 表示输出，后面是文件夹路径默认会带上-c，在当前路径下寻找配置文件(apidoc.json)，如果找不到则会在package.json中寻找 &quot;apidoc&quot;: { } myapp/ 表示要生成api的源文档所在目录位置 mytemplete/ 表示要生成api到的目录位置</pre><div class="contentsignin">ログイン後にコピー</div></div> を使用します。例:

app/Http/Controllers を実行したい/Api/

ディレクトリ内のドキュメントから API ファイルを public/api に生成するコマンドは次のとおりです: <div class="code" style="position:relative; padding:0px; margin:0px;"><pre class='brush:php;toolbar:false;'>apidoc -i app/Http/Controllers/Api/ -o public/api</pre><div class="contentsignin">ログイン後にコピー</div></div> 表示:

ディレクトリ構造は次のとおりです:

以上がLaravelでapidocを使う方法を教えます!の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。