alvinone/laravel-apidoc-generator

此包已废弃,不再维护。作者建议使用 alvinone/laravel-apidoc-generator 包。

从您的Laravel应用程序生成美观的API文档

4.8.2 2020-05-28 14:10 UTC

README

从现有的Laravel/Lumen/Dingo 路由自动生成API文档。

php artisan apidoc:generate

Latest Stable VersionTotal Downloads License codecov.io Scrutinizer Code Quality Build Status StyleCI

安装

需要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

这将在您的config文件夹中创建一个apidoc.php文件。

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');

文档

请在Beyond Code主页查看文档。

许可

Laravel API文档生成器是免费软件,根据MIT许可协议授权。