基于 laravel 框架支持 5.5 版本, 读取数据库信息生成数据库字典, 通过控制器注释生成API接口文档, 注册 ddoc 路由网页形式呈现
- 前端呈现使用的 docute.
- API 注释生成采用的 dingo/blueprint.
- 参考了 jormin/laravel-ddoc.
composer.json 添加, composer update
安装.
"require": {
"wxm/ddoc": "1.0.*@dev"
},
-
注册 ServiceProvider (laravel 5.5 不需要注册):
Wxm\DDoc\DDocServiceProvider::class
-
发布配置、资源、视图文件:
php artisan vendor:publish --provider="Wxm\DDoc\DDocServiceProvider" --force
-
开启服务器:
php artisan serve
-
访问
http://localhost:8000/ddoc
默认开启验证, 验证密码
root
参考 API Blueprint Documentation.
The MIT License (MIT). Please see License File for more information.