hurongsheng/laravel-route-doc

基于 route.php 文件轻松创建文档

维护者

详细信息

github.com/hurongsheng/laravel-route-doc

源代码

问题

安装次数: 153

依赖者: 0

建议者: 0

安全: 0

星标: 1

关注者: 2

分支: 0

公开问题: 0

2.1.5 2016-12-30 03:26 UTC

Requires

MIT 6626ed25f2cd891f9b5d15586ebf189378cf468f

  • hurongsheng <plokm031004.woop@126.com>

routeapidoclaravel

This package is not auto-updated.

Last update: 2024-09-18 19:59:28 UTC

README

create api doc based on route.php & controller's document.

安装

使用以下命令使用 composer 安装此包

composer require hurongsheng/laravel-route-doc

用法

add hurongsheng\LaravelRouteDoc\RouteDocServiceProvider::class into config/app.php--providers
php artisan vendor:publish --provider="hurongsheng\LaravelRouteDoc\RouteDocServiceProvider"
php artisan migrate
declare SomeController extend hurongsheng\LaravelRouteDoc\Controllers\RouteDocController;
and declare Route::controller() SomeController;
hurongsheng\LaravelRouteDoc\Controllers\RouteDocController extend App\Http\Controllers\Controller
     config:config/route_doc.php
     RouteDocController@getManage return default view of doc
     RouteDocController@getList return default view of doc
     
     visit manage and click update route&update doc then wait reload

控制器文档中的规则

/**
 * @description   function description
 * @param Request $request
 * @param         $id
 * @request       $name
 * @request       $something
 * @return SomeClass
 * @author your name
 */
 
 @request==@param

辅助工具

当在 phpstorm 中时，添加 @description @request 文档

http://jingyan.baidu.com/article/48b558e35b81c27f38c09ab7.html