目次
laravel-doc
インストール要件
インストール
Visit /doc、このプロジェクトのドキュメントを参照できます
Visit /apidoc では、このプロジェクトのインターフェイス説明ドキュメントが表示されます。
使用方法
一般的なドキュメントの作成
app/Http/Controllers/Docs ドキュメントを /LaravelDocController.php
langages
設定に#があり、インターフェイスがAjaxリクエストを行うと、
ホームページ PHPフレームワーク Laravel Laravelドキュメントツール

Laravelドキュメントツール

Jul 03, 2019 pm 02:33 PM
laravel

Laravelドキュメントツール

laravel-doc

laravel-doc は、ドキュメントの生成、マークダウンによるドキュメントの作成、ドキュメントへの Web アクセスの提供に使用されるツールです。プロジェクト

インストール要件

  • PHP >= 7.0.0
  • Laravel >= 5

インストール

 composer require foryoufeng/laravel-doc
ログイン後にコピー

Laravel 5.5 以前を実行している場合は、config/app.php にサービス プロバイダーを追加する必要があります:

 Foryoufeng\Doc\DocServiceProvider::class
ログイン後にコピー

次のコマンドを実行してリソース ファイルを公開します

 php artisan doc:install
ログイン後にコピー

リソースを公開すると、さらに多くのファイルが表示されます

/public/vendor/laravel-doc  //样式文件

/resources/views/docs   //界面文件

/resources/mds/docs  //文档文件

/resources/mds/apidocs  //api文件

/app/Http/Controllers/Docs  //增加了控制器文件

config/laravel_doc.php  //文档配置文件

routes/web.php中增加了路由文件
ログイン後にコピー

Visit /doc、このプロジェクトのドキュメントを参照できます

Visit /apidoc では、このプロジェクトのインターフェイス説明ドキュメントが表示されます。

使用方法

一般的なドキュメントの作成

resources/mds/docs# にあります。 ##demo.md などの md ファイルを作成し、必要なコンテンツを追加して、app/Http/Controllers/Docs/LaravelDocController.php# の に移動します。 ## データを index_md
に追加してアクセスします。例: <div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:php;toolbar:false">//默认已经加入了2个例子 private function index_md()     {         return  [             [                 'name' =&gt; config('laravel_doc.languages.install'),                 'doc_link' =&gt; 'install.md',             ],             [                 'name' =&gt; config('laravel_doc.languages.how_use'),                 'doc_link' =&gt; 'how_use.md',             ],             [                 'name' =&gt; 'demo',                 'doc_link' =&gt; 'demo.md',             ],         ];     }</pre><div class="contentsignin">ログイン後にコピー</div></div> 次に、/doc にアクセスして効果を確認します。

コントローラーの説明デフォルトのドキュメント パス

$this->mds_path=resource_path('mds/docs/');
ログイン後にコピー

getMenu()

内部のコードはドキュメントに表示されるメニューです。これはドキュメントの作成に必要なものです。

複数のメニューの構成例<div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:php;toolbar:false">protected function getMenu() return [             [                 'name'=&gt;config('laravel_doc.languages.project_doc'),                 'spread'=&gt;true,//菜单是否展开,false不展开                 'children'=&gt;[                         'name'=&gt;config('laravel_doc.languages.install'),                         'doc_link'=&gt;'install.md',                      ],             ],             [                 'name'=&gt;config('laravel_doc.languages.project_doc'),                 'spread'=&gt;false,//不展开菜单                 'children'=&gt;[                         'name'=&gt;config('laravel_doc.languages.install'),                         'doc_link'=&gt;'install.md',                  ],             ],         ]; }</pre><div class="contentsignin">ログイン後にコピー</div></div>

メニューを構成した後、
    resources/mds/docs
  • doc_link
  • で指定された新しい md ファイルを作成し、ドキュメントを書き込むことができますAPI インターフェイス ドキュメントの作成

resources/mds/apidocs

demo.md

などの md ファイルを作成します。必要なコンテンツを追加します。 次に、アクセスするために app/Http/Controllers/Docs/LaravelApiDocController.phpindex_md
にデータを追加します。例: <div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:php;toolbar:false">private function index_md()     {         return  [             [                 'name' =&gt; 'apidoc_html',                 'doc_link' =&gt; 'apidoc_html.md',                 //可自行修改你的$this-&gt;host来使用你自己定义的访问地址                 'url' =&gt; $this-&gt;host.'apidoc/html',                 'request_type' =&gt; 'get',//请求方式 get或者post                 //请求参数                 'params'=&gt;[                     'name'=&gt;'apidoc_html.md',                 ]             ],             [                 'name' =&gt; 'demo',                 'doc_link' =&gt; 'demo.md',                 'url' =&gt; $this-&gt;host.'apidoc/html',                 'request_type' =&gt; 'get',//请求方式 get或者post                 //给定一些需要请求的参数                 'params'=&gt;[                     'name'=&gt;'',                     'user_id'=&gt;'',                 ]             ],         ];     }</pre><div class="contentsignin">ログイン後にコピー</div></div>その後、/apidoc にアクセスすると、その効果がわかります。

提供されたデモ:apidoc_html をクリックすると、上記のリクエストが表示されますパスと必要なリクエストパラメータ、および次のパラメータドキュメント

Send request ボタンをクリックして ajax リクエストを実行すると、インターフェースに問題がなければ、ajax データが返されます。

このとき、

をクリックしてドキュメント を生成すると、markdown
の編集ボックスが表示され、右側のレンダリングが開き、リクエストのパス、パラメータ、戻り値を取得するインターフェースです。 、現在クリックされているページ で定義されているものなど、プレビュー効果で Interface PersonParameter description
を変更して、各パラメータ、、および戻り値の説明を説明できます。などを入力して、Generate ボタンをクリックすると、定義した $this->mds_path
に従って、構成した doc_link例: resources/mds/apidocs/demo.md、ファイルを生成するためのファイル
laravel_doc.php

構成ファイルの説明
    //laravel-doc的名字
    'name' => 'Laravel-doc',
    //用在了定义撰写接口人的名字
    'author' => env('DOC_AUTHOR','foryoufeng'),
    //接口请求发送了这个token
    'token' => env('DOC_TOKEN','doc'),
    //做国际化时可以用到
    'languages'=>[
        'search'=>'搜索',
        'search_result'=>'搜索结果',
        'project_doc'=>'项目文档',
        'doc_name'=>'文档名称',
        'install'=>'安装',
        'how_use'=>'使用说明',
        'request_type'=>'http请求方式',
        'request_url'=>'请求地址',
        'send_request'=>'发送请求',
        'generate_doc'=>'生成文档',
        'welcome_use'=>'欢迎使用',
        'param'=>'参数',
        'value'=>'值',
        'generate'=>'生成',
    ]
ログイン後にコピー

上級

複数のプロジェクト

プロジェクトが比較的小規模で、1 つのドキュメントと 1 つの API インターフェイス ドキュメントのみを作成する必要がある場合は、
    app/Http/Controllers に記述します。 /Docs/LaravelApiDocController.php
  • および

    app/Http/Controllers/Docs ドキュメントを /LaravelDocController.php

    に追加すると、基本的に要件を満たしているはずです #複数のプロジェクトがある場合は、
    app/Http/Controllers/Docs

    ,
  • resources/views/docs
をコピーし、

resources/mds に新しいディレクトリを作成できます/ ドキュメントを作成する予定のディレクトリ を作成し、ルーティング ファイルに必要なルートを定義します。次のルートをコピーする必要があります<div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:php;toolbar:false">//doc route Route::group(['namespace'=&gt;'Docs'],function (){     Route::get('doc', 'LaravelDocController@index')-&gt;name('doc.index');     //md文件返回到html     Route::get('doc/html', 'LaravelDocController@html')-&gt;name('doc.html');     Route::get('apidoc', 'LaravelApiDocController@index')-&gt;name('doc.apidoc');     //md文件返回到html     Route::get('apidoc/html', 'LaravelApiDocController@html')-&gt;name('doc.apidoc.html');     //预览api文档     Route::post('apidoc/markdown', 'LaravelApiDocController@markdown')-&gt;name('doc.apidoc.markdown');     //生成api文档     Route::post('apidoc/save', 'LaravelApiDocController@save')-&gt;name('doc.apidoc.save'); });</pre><div class="contentsignin">ログイン後にコピー</div></div>Internationalization

    config/laravel_doc.php
  • langages

    を変更できます。言語を変更します。デフォルトは

    中国語 です。インターフェイスインターセプト

  • config/laravel_doc.php
  • ##token

    設定に#があり、インターフェイスがAjaxリクエストを行うと、

    Access-Token

    が含まれますheader インターフェイスは、この設定に基づいて middle を作成できます。たとえば、指定された token を使用してファイル を処理すると、次のように取得できます。対応するユーザー情報の取得、インターフェイスのリクエストと割り当ての実行など。
    ヒント

  • ユニバーサル プロジェクトのために、私は次のことを行いました。ドキュメントやインターフェイスを傍受するミドルウェアは提供しません。セキュリティ上の理由から、ユーザーがドキュメントを保護するために自分のニーズに応じてミドルウェアを作成できるようにすることをお勧めします
  • Laravel 関連の技術記事の詳細については、## を参照してください。 #Laravel チュートリアル
  • 学ぶべきコラム!

以上がLaravelドキュメントツールの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

このウェブサイトの声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。

ホットAIツール

Undresser.AI Undress

Undresser.AI Undress

リアルなヌード写真を作成する AI 搭載アプリ

AI Clothes Remover

AI Clothes Remover

写真から衣服を削除するオンライン AI ツール。

Undress AI Tool

Undress AI Tool

脱衣画像を無料で

Clothoff.io

Clothoff.io

AI衣類リムーバー

AI Hentai Generator

AI Hentai Generator

AIヘンタイを無料で生成します。

ホットツール

メモ帳++7.3.1

メモ帳++7.3.1

使いやすく無料のコードエディター

SublimeText3 中国語版

SublimeText3 中国語版

中国語版、とても使いやすい

ゼンドスタジオ 13.0.1

ゼンドスタジオ 13.0.1

強力な PHP 統合開発環境

ドリームウィーバー CS6

ドリームウィーバー CS6

ビジュアル Web 開発ツール

SublimeText3 Mac版

SublimeText3 Mac版

神レベルのコード編集ソフト(SublimeText3)

PHP vs. Flutter: モバイル開発に最適な選択 PHP vs. Flutter: モバイル開発に最適な選択 May 06, 2024 pm 10:45 PM

PHP と Flutter は、モバイル開発でよく使われるテクノロジです。 Flutter は、クロスプラットフォーム機能、パフォーマンス、ユーザー インターフェイスに優れており、高パフォーマンス、クロスプラットフォーム、カスタマイズされた UI を必要とするアプリケーションに適しています。 PHP は、クロスプラットフォームではなく、パフォーマンスが低いサーバー側アプリケーションに適しています。

PHP でオブジェクト リレーショナル マッピング (ORM) を使用してデータベース操作を簡素化するにはどうすればよいですか? PHP でオブジェクト リレーショナル マッピング (ORM) を使用してデータベース操作を簡素化するにはどうすればよいですか? May 07, 2024 am 08:39 AM

PHP でのデータベース操作は、オブジェクトをリレーショナル データベースにマップする ORM を使用して簡素化されます。 Laravel の EloquentORM を使用すると、オブジェクト指向構文を使用してデータベースと対話できます。モデル クラスを定義したり、Eloquent メソッドを使用したり、実際にブログ システムを構築したりすることで ORM を使用できます。

PHP単体テストツールの長所と短所の分析 PHP単体テストツールの長所と短所の分析 May 06, 2024 pm 10:51 PM

PHP 単体テスト ツール分析: PHPUnit: 大規模プロジェクトに適しており、包括的な機能を提供し、インストールが簡単ですが、冗長で遅い場合があります。 PHPUnitWrapper: 小規模プロジェクトに適しており、使いやすく、Lumen/Laravel に最適化されていますが、機能が限られており、コード カバレッジ分析は提供されず、コミュニティ サポートも限られています。

Laravel - アーティザンコマンド Laravel - アーティザンコマンド Aug 27, 2024 am 10:51 AM

Laravel - アーティザン コマンド - Laravel 5.7 には、新しいコマンドを処理およびテストするための新しい方法が付属しています。これには職人コマンドをテストする新しい機能が含まれており、そのデモについては以下で説明します。

Laravel と CodeIgniter の最新バージョンの比較 Laravel と CodeIgniter の最新バージョンの比較 Jun 05, 2024 pm 05:29 PM

Laravel 9 と CodeIgniter 4 の最新バージョンでは、更新された機能と改善が提供されます。 Laravel9はMVCアーキテクチャを採用しており、データベース移行、認証、テンプレートエンジンなどの機能を提供します。 CodeIgniter4 は、HMVC アーキテクチャを使用してルーティング、ORM、およびキャッシュを提供します。パフォーマンスの面では、Laravel9 のサービスプロバイダーベースの設計パターンと CodeIgniter4 の軽量フレームワークにより、優れたパフォーマンスが得られます。実際のアプリケーションでは、Laravel9 は柔軟性と強力な機能を必要とする複雑なプロジェクトに適しており、CodeIgniter4 は迅速な開発や小規模なアプリケーションに適しています。

Laravel と CodeIgniter のデータ処理機能はどのように比較されますか? Laravel と CodeIgniter のデータ処理機能はどのように比較されますか? Jun 01, 2024 pm 01:34 PM

Laravel と CodeIgniter のデータ処理機能を比較します。 ORM: Laravel はクラスとオブジェクトのリレーショナル マッピングを提供する EloquentORM を使用しますが、CodeIgniter は ActiveRecord を使用してデータベース モデルを PHP クラスのサブクラスとして表します。クエリビルダー: Laravel には柔軟なチェーンクエリ API がありますが、CodeIgniter のクエリビルダーはよりシンプルで配列ベースです。データ検証: Laravel はカスタム検証ルールをサポートする Validator クラスを提供しますが、CodeIgniter には組み込みの検証関数が少なく、カスタム ルールの手動コーディングが必要です。実践例:ユーザー登録例はLarを示しています

PHPコードの単体テストと統合テスト PHPコードの単体テストと統合テスト May 07, 2024 am 08:00 AM

PHP 単体テストおよび統合テスト ガイド 単体テスト: コードまたは関数の単一単位に焦点を当て、PHPUnit を使用して検証用のテスト ケース クラスを作成します。統合テスト: 複数のコードユニットがどのように連携するかに注意し、PHPUnit の setUp() メソッドと TearDown() メソッドを使用してテスト環境をセットアップおよびクリーンアップします。実際のケース: PHPUnit を使用して、データベースの作成、サーバーの起動、テストコードの作成など、Laravel アプリケーションの単体テストと統合テストを実行します。

Laravel と CodeIgniter: 大規模プロジェクトにはどちらのフレームワークが適していますか? Laravel と CodeIgniter: 大規模プロジェクトにはどちらのフレームワークが適していますか? Jun 04, 2024 am 09:09 AM

大規模プロジェクト用のフレームワークを選択する場合、Laravel と CodeIgniter にはそれぞれ独自の利点があります。 Laravel はエンタープライズレベルのアプリケーション向けに設計されており、モジュール設計、依存関係の注入、強力な機能セットを提供します。 CodeIgniter は、速度と使いやすさを重視した、小規模から中規模のプロジェクトに適した軽量フレームワークです。複雑な要件と多数のユーザーを伴う大規模なプロジェクトには、Laravel のパワーとスケーラビリティがより適しています。単純なプロジェクトやリソースが限られている状況では、CodeIgniter の軽量で迅速な開発機能がより理想的です。

See all articles