# 说明
该项目,主要用于解决API文档生成的问题。
项目基于laravel5+swagger-php构成。[项目源地址](https://github.com/slampenny/Swaggervel)
# 改进日志
* V1.1.1 修改了依赖swagger-php包版本问题(swagger-php v2上的版本使用了PSR-4标准)
* 2015年7月1日 [v1.1.0] 修改路由
* 修改了项目文件结构
* 将swagger前端部分版本提升到V2.1版本,使用swagger前端[项目地址](https://github.com/helei112g/swagger-ui)
* 将项目改进为PSR-4自动加载,抛弃之前的PSR-0
# 安装
建议采用 `composer` 进行安装,
1. 在项目的composer.json中配置 `"riverslei/laravel-swagger": "~1.0"`
2. 运行 `composer update`
3. 安装完成后,配置 `config/app.php` 中的服务提供者 `Riverslei\Swaggervel\SwaggervelServiceProvider::class`
4. 以上配置完成后,运行 `php artisan vendor:publish` ,生成相关的配置文件以及资源文件。
*通过以上配置,已经完成了所有的安装工作,现在开始运行*
# 运行
查看api-doc的路由,使用一下命令
```artisan
php artisan route:list
```
根据路由信息,访问:baseUrl+api-docs,如果看到swagger的首页,说明已经成功
# 补充
安装该lib后,不需要再运行命令生成相关的json文件,一切在你运行url访问你项目swagger文档首页时,它会自动扫描相关的Model及Controller
,一切就是这么美妙,以后再也不需要劳心费神的写api接口文档了。
这里给出swagger-php注解的书写规则文档:[官方文档](http://zircote.com/swagger-php/annotations.html)
没有合适的资源?快使用搜索试试~ 我知道了~
资源推荐
资源详情
资源评论
收起资源包目录
初始化基于laravel5+swagger-php的api接口自动生成系统.zip (54个子文件)
laravel-swagger-master
.travis.yml 179B
.gitattributes 378B
resources
views
index.blade.php 5KB
.gitkeep 0B
src
routes.php 4KB
SwaggervelServiceProvider.php 1KB
composer.json 594B
tests
.gitkeep 0B
public
lib
underscore-min.map 27KB
handlebars-2.0.0.js 47KB
underscore-min.js 15KB
jquery.slideto.min.js 369B
swagger-oauth.js 9KB
jquery.wiggle.min.js 762B
highlight.7.3.pack.js 7KB
backbone-min.js 20KB
jquery-1.8.0.min.js 90KB
marked.js 27KB
jquery.ba-bbq.min.js 4KB
lang
zh-CN.js 2KB
translator.js 1KB
en.js 2KB
o2c.html 449B
swagger-ui.js 2.24MB
css
style.css 5KB
reset.css 1KB
screen.css 44KB
typography.css 1KB
print.css 41KB
swagger-ui.min.js 358KB
images
explorer_icons.png 6KB
wordnik_api.png 980B
favicon-32x32.png 2KB
favicon.ico 5KB
logo_small.png 770B
throbber.gif 9KB
pet_store_api.png 824B
favicon-16x16.png 645B
fonts
droid-sans-v6-latin-700.woff 25KB
droid-sans-v6-latin-regular.woff2 11KB
droid-sans-v6-latin-700.ttf 40KB
droid-sans-v6-latin-regular.woff 24KB
droid-sans-v6-latin-700.eot 22KB
droid-sans-v6-latin-700.woff2 11KB
droid-sans-v6-latin-regular.ttf 38KB
droid-sans-v6-latin-regular.eot 21KB
droid-sans-v6-latin-regular.svg 70KB
droid-sans-v6-latin-700.svg 72KB
.gitignore 649B
phpunit.xml 570B
README.md 2KB
config
local
swaggervel.php 75B
.gitkeep 0B
swagger.php 3KB
共 54 条
- 1
资源评论
白话机器学习
- 粉丝: 8939
- 资源: 7681
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功