通过 
搜索
搜索toanld / laravel-apidoc-generator
从您的 Laravel 应用程序生成美观的 API 文档
4.0.2
2019-11-25 21:07 UTC
Requires
- php: >=7.2.0
- fzaninotto/faker: ^1.8
- illuminate/console: ^5.7|^6.0
- illuminate/routing: ^5.7|^6.0
- illuminate/support: ^5.7|^6.0
- league/flysystem: ^1.0
- mpociot/documentarian: ^0.3.0
- mpociot/reflection-docblock: ^1.0.1
- nunomaduro/collision: ^3.0
- ramsey/uuid: ^3.8
- symfony/var-exporter: ^4.0
Requires (Dev)
- dingo/api: ^2.3.0
- league/fractal: ^0.17.0
- mockery/mockery: ^1.2.0
- orchestra/testbench: ^3.7.0 || ^4.0
- phpstan/phpstan: ^0.11.15
- phpunit/phpunit: ^7.5.0
Suggests
- league/fractal: Required for transformers support
- dev-master
- v4.x-dev
- 4.0.2
- 4.0.1
- 4.0.0
- 4.0.0-rc1
- 4.0.0-alpha
- 3.x-dev
- 3.17.1
- 3.17.0
- 3.16.3
- 3.16.2
- 3.16.1
- 3.16.0
- 3.15.1
- 3.15.0
- 3.14.0
- 3.12.0
- 3.11.0
- 3.10.0
- 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-fix-rebuild
This package is auto-updated.
Last update: 2024-09-15 19:23:55 UTC
README
自动从您现有的 Laravel/Lumen/Dingo 路由生成 API 文档。 这里展示了输出结果。
php artisan apidoc:generate
安装
需要 PHP 7.2 和 Laravel/Lumen 5.7 或更高版本。
如果您的应用程序不符合这些要求，您可以选择查看 3.x 分支以获取旧版本发布。
composer require --dev mpociot/laravel-apidoc-generator
Laravel
通过运行以下命令发布配置文件
php artisan vendor:publish --provider="Mpociot\ApiDoc\ApiDocGeneratorServiceProvider" --tag=apidoc-config
这将创建一个 apidoc.php 文件在您的 config 文件夹中。
Lumen
- 当使用 Lumen 时，您需要运行
composer require mpociot/laravel-apidoc-generator。 - 在您的
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 上的文档。如果您是从 v3 迁移到 v4，别忘了查看迁移指南。
许可协议
Laravel API 文档生成器是免费软件，许可协议为 MIT 协议。