Package Data | |
---|---|
Maintainer Username: | helei112g |
Maintainer Contact: | helei5200@126.com (helei112g) |
Package Create Date: | 2015-06-29 |
Package Last Update: | 2015-07-08 |
Language: | JavaScript |
License: | MIT |
Last Refreshed: | 2024-11-15 03:00:52 |
Package Statistics | |
---|---|
Total Downloads: | 790 |
Monthly Downloads: | 1 |
Daily Downloads: | 0 |
Total Stars: | 59 |
Total Watchers: | 8 |
Total Forks: | 24 |
Total Open Issues: | 0 |
该项目,主要用于解决API文档生成的问题。 项目基于laravel5+swagger-php构成。项目源地址
建议采用 composer
进行安装,
"riverslei/laravel-swagger": "~1.0"
composer update
config/app.php
中的服务提供者 Riverslei\Swaggervel\SwaggervelServiceProvider::class
php artisan vendor:publish
,生成相关的配置文件以及资源文件。通过以上配置,已经完成了所有的安装工作,现在开始运行
查看api-doc的路由,使用一下命令
php artisan route:list
根据路由信息,访问:baseUrl+api-docs,如果看到swagger的首页,说明已经成功
安装该lib后,不需要再运行命令生成相关的json文件,一切在你运行url访问你项目swagger文档首页时,它会自动扫描相关的Model及Controller ,一切就是这么美妙,以后再也不需要劳心费神的写api接口文档了。
这里给出swagger-php注解的书写规则文档:官方文档