guglielmoseminara / laravel-apidoc-generator
从您的 Laravel 应用程序生成美观的 API 文档
5.0.0
2021-07-26 14:42 UTC
Requires
- php: >=7.2.0
- fzaninotto/faker: ~1.8
- illuminate/console: ^5.7|^6.0|^7.0|^8.0
- illuminate/routing: ^5.7|^6.0|^7.0|^8.0
- illuminate/support: ^5.7|^6.0|^7.0|^8.0
- league/flysystem: ^1.0
- mpociot/documentarian: ^0.4.0
- mpociot/reflection-docblock: ^1.0.1
- nunomaduro/collision: ^3.0|^4.0|^5.0
- ramsey/uuid: ^3.8|^4.0
- symfony/var-exporter: ^4.0|^5.0
Requires (Dev)
- dms/phpunit-arraysubset-asserts: ^0.1.0
- laravel/lumen-framework: ^5.7|^6.0|^7.0|^8.0
- league/fractal: ^0.19.0
- orchestra/testbench: ^3.7|^4.0|^5.0
- phpstan/phpstan: ^0.11.15
- phpunit/phpunit: ^8.0
Suggests
- league/fractal: Required for transformers support
- dev-master
- 5.0.0
- 4.x-dev
- 4.0.0
- 3.10.0
- 3.9.1
- 3.9.0
- 3.8.0
- 3.7.2
- 3.7.1
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.4
- 3.4.3
- 3.4.2
- 3.4.1
- 3.4.0
- 3.3.2
- 3.3.1
- 3.3.0
- 3.2.0
- 3.1.1
- 3.1.0
- 3.0.6
- 3.0.5
- 3.0.4
- 3.0.3
- 3.0.2
- 3.0.1
- 3.0.0
- 2.x-dev
- 2.1.8
- 2.1.7
- 2.1.6
- 2.1.5
- 2.1.4
- 2.1.3
- 2.1.2
- 2.1.1
- 2.1.0
- 2.0.0
- 1.7.0
- 1.6.7
- 1.6.6
- 1.6.5
- 1.6.4
- 1.6.3
- 1.6.2
- 1.6.1
- 1.6.0
- 1.5.2
- 1.5.1
- 1.5.0
- 1.4.4
- 1.4.3
- 1.4.2
- 1.4.1
- 1.4.0
- 1.3.0
- 1.2.6
- 1.2.5
- 1.2.4
- 1.2.3
- 1.2.2
- 1.2.1
- 1.2.0
- 1.1.1
- 1.1.0
- 1.0.1
- 1.0.0
- 0.2.0
- 0.1.0
- dev-patch-1
- dev-seed-faker
- dev-apply-bindings-in-examples
- dev-support-binding-prefixes
- dev-replace-env-with-config
- dev-shalvah-patch-1
This package is auto-updated.
Last update: 2024-09-10 18:52:14 UTC
README
自动从现有的 Laravel/Lumen/Dingo 路由生成您的 API 文档。 这是输出效果。
php artisan apidoc:generate
安装
需要 PHP 7 和 Laravel 5.5 或更高版本。
composer require mpociot/laravel-apidoc-generator
Laravel
通过运行以下命令发布配置文件:
php artisan vendor:publish --provider="Mpociot\ApiDoc\ApiDocGeneratorServiceProvider" --tag=apidoc-config
这将创建一个 apidoc.php
文件在您的 config
文件夹中。
Lumen
- 在您的
bootstrap/app.php
中注册服务提供者
$app->register(\Mpociot\ApiDoc\ApiDocGeneratorServiceProvider::class);
- 将配置文件从
vendor/mpociot/laravel-apidoc-generator/config/apidoc.php
复制到您的项目作为config/apidoc.php
。然后添加到您的bootstrap/app.php
$app->configure('apidoc');
文档
查看文档在 ReadTheDocs。
许可证
Laravel API 文档生成器是免费软件,根据 MIT 许可证授权。