목차
laravel-doc
安装要求
安装
访问/doc,即可看到本项目的说明文档
访问/apidoc,即可看到本项目的接口说明文档
如何使用
普通文档的编写
控制器说明
api接口文档的编写
进阶
多项目
国际化
接口拦截
설치 요구 사항
일반 문서 작성
API 인터페이스 문서 작성
여러 프로젝트
국제화
인터페이스 차단
PHP 프레임워크 Laravel Laravel 문서화 도구

Laravel 문서화 도구

Jul 03, 2019 pm 02:33 PM
laravel

Laravel 문서화 도구

laravel-doc

laravel-doc는 문서를 생성하고, 마크다운을 통해 문서를 작성하고, 문서에 대한 웹 액세스를 제공하는 데 사용되는 프로젝트입니다laravel-doc 是一个用来生成文档,通过markdown来撰写文档,并提供web访问文档的项目

安装要求

  • PHP >= 7.0.0
  • Laravel >= 5

安装

 composer require foryoufeng/laravel-doc
로그인 후 복사

如果你是运行的Laravel 5.5以下的版本,需要在config/app.php的service provider中添加:

 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中增加了路由文件
로그인 후 복사

访问/doc,即可看到本项目的说明文档

访问/apidoc,即可看到本项目的接口说明文档

如何使用

普通文档的编写

resources/mds/docs中创建你的md文件,如demo.md,加入你需要的内容,
然后到app/Http/Controllers/Docs/LaravelDocController.phpindex_md中加入数据即可访问,例如:

//默认已经加入了2个例子
private function index_md()
    {
        return  [
            [
                'name' => config('laravel_doc.languages.install'),
                'doc_link' => 'install.md',
            ],
            [
                'name' => config('laravel_doc.languages.how_use'),
                'doc_link' => 'how_use.md',
            ],
            [
                'name' => 'demo',
                'doc_link' => 'demo.md',
            ],
        ];
    }
로그인 후 복사

然后访问/doc,即可看到效果

控制器说明

默认文档的路径

$this->mds_path=resource_path('mds/docs/');
로그인 후 복사

getMenu()里面的代码是文档显示的菜单,这个是写文档需要用到的

  • 配置多个菜单示例
    protected function getMenu()
    return [
                [
                    'name'=>config('laravel_doc.languages.project_doc'),
                    'spread'=>true,//菜单是否展开,false不展开
                    'children'=>[
                            'name'=>config('laravel_doc.languages.install'),
                            'doc_link'=>'install.md',
                         ],
                ],
                [
                    'name'=>config('laravel_doc.languages.project_doc'),
                    'spread'=>false,//不展开菜单
                    'children'=>[
                            'name'=>config('laravel_doc.languages.install'),
                            'doc_link'=>'install.md',
                     ],
                ],
            ];
    }
    로그인 후 복사
  • 配置好菜单后可以在resources/mds/docs中新建doc_link中指定的md文件,然后进行文档的编写

api接口文档的编写

resources/mds/apidocs中创建你的md文件,如demo.md,加入你需要的内容,
然后到app/Http/Controllers/Docs/LaravelApiDocController.phpindex_md中加入数据即可访问,例如:

private function index_md()
    {
        return  [
            [
                'name' => 'apidoc_html',
                'doc_link' => 'apidoc_html.md',
                //可自行修改你的$this->host来使用你自己定义的访问地址
                'url' => $this->host.'apidoc/html',
                'request_type' => 'get',//请求方式 get或者post
                //请求参数
                'params'=>[
                    'name'=>'apidoc_html.md',
                ]
            ],
            [
                'name' => 'demo',
                'doc_link' => 'demo.md',
                'url' => $this->host.'apidoc/html',
                'request_type' => 'get',//请求方式 get或者post
                //给定一些需要请求的参数
                'params'=>[
                    'name'=>'',
                    'user_id'=>'',
                ]
            ],
        ];
    }
로그인 후 복사

然后访问/apidoc,即可看到效果

点击提供的demo:apidoc_html,即可看到上面的请求路径和需要的请求参数,以及下面的参数文档

点击发送请求按钮,可以执行ajax请求,如果接口没有问题的话,就会返回ajax数据了
这个时候点击生成文档,会打开一个markdown的编辑框和右侧的效果图,该界面获取了当前点击页面
中定义的请求路径,参数,返回值等,在预览效果中你可以修改接口人参数说明中对每个参数进行说明,
以及返回值的说明等,然后点击生成按钮,会根据你定义的$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'=>'生成',
    ]
로그인 후 복사

进阶

  • 多项目

    如果你的项目比较小,只用写一个文档和一个api接口文档,那么在app/Http/Controllers/Docs/LaravelApiDocController.phpapp/Http/Controllers/Docs/LaravelDocController.php
    中加入你的文档应该基本满足要求

如果有多个项目,可以复制app/Http/Controllers/Docsresources/views/docs,可以在resources/mds/目录中新建你准备写文档的目录
然后在路由文件中定义好需要的路由,需要复制下面的这些路由

//doc route
Route::group(['namespace'=>'Docs'],function (){
    Route::get('doc', 'LaravelDocController@index')->name('doc.index');
    //md文件返回到html
    Route::get('doc/html', 'LaravelDocController@html')->name('doc.html');
    Route::get('apidoc', 'LaravelApiDocController@index')->name('doc.apidoc');
    //md文件返回到html
    Route::get('apidoc/html', 'LaravelApiDocController@html')->name('doc.apidoc.html');
    //预览api文档
    Route::post('apidoc/markdown', 'LaravelApiDocController@markdown')->name('doc.apidoc.markdown');
    //生成api文档
    Route::post('apidoc/save', 'LaravelApiDocController@save')->name('doc.apidoc.save');

});
로그인 후 복사
  • 国际化

    可以修改config/laravel_doc.php中的languages来更换语言,默认提供的是中文

  • 接口拦截

    config/laravel_doc.php中有一个token的配置,接口做ajax请求时在header中带了Access-Token,接口可以根据这个配置,
    做一个中间件的处理,比如使用指定的token就可以获取对应用户的信息,进行接口的请求和赋值等

  • tips

项目为了通用,我并没有提供中间件进行文档和接口的拦截,出于安全考虑,建议使用者可以根据自身需求编写中间件进行文档的保护

설치 요구 사항

  • PHP >= 7.0.0
  • Laravel >= 5
  • Installation

    rrreeeLaravel 5.5 미만 버전을 실행하는 경우 다음이 필요합니다. config/app.php의 서비스 공급자 추가: rrreee

    다음 명령을 실행하여 리소스 파일을 게시하세요🎜rrreee🎜리소스를 게시한 후에는 더 많은 파일이 있을 것입니다🎜rrreee🎜 방문 /doc, 이 프로젝트의 문서를 볼 수 있습니다🎜🎜<code>/apidoc를 방문하면 이 프로젝트의 인터페이스 문서를 볼 수 있습니다🎜🎜사용 방법🎜

    일반 문서 작성

    h2>🎜demo.md와 같은 resources/mds/docs에 md 파일을 만들고 필요한 콘텐츠를 추가한 다음
    로 이동하여 app/Http/Controllers/Docs/LaravelDocController.phpindex_md에 데이터를 추가하여 액세스하세요. 예: 🎜rrreee🎜 그런 다음 /doc 효과 보기🎜🎜컨트롤러 설명🎜🎜기본 문서 경로🎜rrreee🎜<code>getMenu()안의 코드는 문서에 표시되는 메뉴로, 문서 작성에 필요한 메뉴입니다🎜
    • 여러 메뉴 구성 예제rrreee
    • 메뉴를 구성한 후 resources/mds/docsdoc_link
    에 지정된 새 md 파일을 생성할 수 있습니다. code>를 선택한 후 문서 작성

    API 인터페이스 문서 작성

    🎜resources/mds/apidocs에 md 파일을 생성하세요. demo.md와 같은 필요한 콘텐츠를 추가한 다음
    app/Http/Controllers/Docs/LaravelApiDocController.php의 <code>index_md로 이동하세요. 액세스할 데이터를 추가하세요. 예: 🎜rrreee🎜 그런 다음 /apidoc를 방문하여 효과를 확인하세요.🎜🎜제공된 데모를 클릭하세요. apidoc_html를 클릭하여 위 내용을 확인하세요. 요청 경로와 필수 요청 매개변수 그리고 아래 매개변수 문서🎜🎜요청 보내기 버튼을 클릭하면 ajax 요청이 실행됩니다. 인터페이스에 문제가 없으면 ajax 데이터가 반환됩니다.
    이때 문서 생성을 클릭하면 markdown 편집 상자와 오른쪽 렌더링이 열립니다. 이 인터페이스는 현재 클릭한 페이지
    , 반환 값 등. 미리보기 효과에서 인터페이스 사람, 매개변수 설명을 수정하여 각 매개변수를 설명할 수 있습니다.
    반환 값에 대한 설명 등을 입력합니다. 그런 다음 생성 버튼을 클릭하면 정의한 $this->mds_path를 기반으로 합니다.
    resources/mds/apidocs/demo.md와 같이 구성하여 파일🎜
    🎜laravel_doc.php을 생성합니다. > 구성 파일 설명🎜rrreee🎜Advanced🎜
    • 여러 프로젝트

      🎜프로젝트가 상대적으로 작고 하나의 문서와 하나의 API 인터페이스 문서만 작성하면 되는 경우 app/Http/Controllers/Docs/LaravelApiDocController.php 및 app/Http/Controllers/Docs/LaravelDocController.php
      는 기본적으로 요구 사항을 충족해야 합니다🎜 li>
    🎜여러 프로젝트가 있는 경우 app/Http/Controllers/Docs, resources/views/docs를 복사하고 새 프로젝트를 만들 수 있습니다. 문서를 작성하려는 resources/mds/ 디렉터리에
    그런 다음 라우팅 파일에 필요한 경로를 정의해야 합니다.🎜rrreee
    • 국제화

      🎜config/laravel_doc.php언어를 수정하여 언어를 변경할 수 있습니다. 기본값은 중국어🎜
    • 인터페이스 차단

      🎜in config /laravel_doc.phptoken 구성이 있습니다. 인터페이스가 Ajax 요청을 할 때. , 액세스 토큰헤더에 포함됩니다. 인터페이스는
      이 구성을 기반으로 미들웨어 프로세스를 수행할 수 있습니다. 지정된 토큰을 사용하여 해당 사용자 정보를 얻고 인터페이스 요청 및 할당을 수행할 수 있습니다. 프로젝트의 보편화를 위해 문서와 인터페이스를 가로채는 미들웨어를 제공하지 않았습니다. 보안상의 이유로 사용자가 문서를 보호하기 위해 필요에 따라 미들웨어를 작성하는 것이 좋습니다.🎜🎜Laravel 관련 자세한 내용은 기술 관련 기사를 보려면 🎜Laravel Tutorial🎜 칼럼을 방문하세요! 🎜

    위 내용은 Laravel 문서화 도구의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

    본 웹사이트의 성명
    본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 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 옷 제거제

    Video Face Swap

    Video Face Swap

    완전히 무료인 AI 얼굴 교환 도구를 사용하여 모든 비디오의 얼굴을 쉽게 바꾸세요!

    뜨거운 도구

    메모장++7.3.1

    메모장++7.3.1

    사용하기 쉬운 무료 코드 편집기

    SublimeText3 중국어 버전

    SublimeText3 중국어 버전

    중국어 버전, 사용하기 매우 쉽습니다.

    스튜디오 13.0.1 보내기

    스튜디오 13.0.1 보내기

    강력한 PHP 통합 개발 환경

    드림위버 CS6

    드림위버 CS6

    시각적 웹 개발 도구

    SublimeText3 Mac 버전

    SublimeText3 Mac 버전

    신 수준의 코드 편집 소프트웨어(SublimeText3)

    Laravel에서 이메일 전송이 실패 할 때 반환 코드를 얻는 방법은 무엇입니까? Laravel에서 이메일 전송이 실패 할 때 반환 코드를 얻는 방법은 무엇입니까? Apr 01, 2025 pm 02:45 PM

    Laravel 이메일 전송이 실패 할 때 반환 코드를 얻는 방법. Laravel을 사용하여 응용 프로그램을 개발할 때 종종 확인 코드를 보내야하는 상황이 발생합니다. 그리고 실제로 ...

    laravel 일정 작업이 실행되지 않습니다 : 스케줄 후 작업이 실행되지 않으면 어떻게해야합니까? laravel 일정 작업이 실행되지 않습니다 : 스케줄 후 작업이 실행되지 않으면 어떻게해야합니까? Mar 31, 2025 pm 11:24 PM

    laravel 일정 작업 실행 비 응답 문제 해결 Laravel의 일정 작업 일정을 사용할 때 많은 개발자 가이 문제에 직면합니다 : 스케줄 : 실행 ...

    Laravel에서는 이메일로 확인 코드를 보내지 못하는 상황을 처리하는 방법은 무엇입니까? Laravel에서는 이메일로 확인 코드를 보내지 못하는 상황을 처리하는 방법은 무엇입니까? Mar 31, 2025 pm 11:48 PM

    Laravel의 이메일을 처리하지 않는 방법은 LaRavel을 사용하는 것입니다.

    DCAT 관리자에서 데이터를 추가하기 위해 클릭하는 사용자 정의 테이블 기능을 구현하는 방법은 무엇입니까? DCAT 관리자에서 데이터를 추가하기 위해 클릭하는 사용자 정의 테이블 기능을 구현하는 방법은 무엇입니까? Apr 01, 2025 am 07:09 AM

    DCAT를 사용할 때 DCATADMIN (LARAVEL-ADMIN)에서 데이터를 추가하려면 사용자 정의의 테이블 기능을 구현하는 방법 ...

    Laravel - 덤프 서버 Laravel - 덤프 서버 Aug 27, 2024 am 10:51 AM

    Laravel - 덤프 서버 - Laravel 덤프 서버는 Laravel 5.7 버전과 함께 제공됩니다. 이전 버전에는 덤프 서버가 포함되어 있지 않습니다. 덤프 서버는 laravel/laravel 작곡가 파일의 개발 종속성이 됩니다.

    Laravel Redis Connection 공유 : 선택 메소드가 다른 연결에 영향을 미치는 이유는 무엇입니까? Laravel Redis Connection 공유 : 선택 메소드가 다른 연결에 영향을 미치는 이유는 무엇입니까? Apr 01, 2025 am 07:45 AM

    Laravel 프레임 워크 및 Laravel 프레임 워크 및 Redis를 사용할 때 Redis 연결을 공유하는 데 영향을 줄 수 있습니다. 개발자는 문제가 발생할 수 있습니다. 구성을 통해 ...

    Laravel 멀티 테넌트 확장 STANCL/TENANCY : 테넌트 데이터베이스 연결의 호스트 주소를 사용자 정의하는 방법은 무엇입니까? Laravel 멀티 테넌트 확장 STANCL/TENANCY : 테넌트 데이터베이스 연결의 호스트 주소를 사용자 정의하는 방법은 무엇입니까? Apr 01, 2025 am 09:09 AM

    Laravel 다중 테넌트 확장 패키지 패키지 패키지 패키지 패키지 Stancl/Tenancy, ...

    Laravel - 작업 URL Laravel - 작업 URL Aug 27, 2024 am 10:51 AM

    Laravel - 액션 URL - Laravel 5.7에는 &quot;호출 가능한 액션 URL&quot;이라는 새로운 기능이 도입되었습니다. 이 기능은 액션 메소드에서 문자열을 허용하는 Laravel 5.6의 기능과 유사합니다. Laravel 5.7에 도입된 새로운 구문의 주요 목적은

    See all articles