lai0n/laravel-apidoc-generator

此包已被弃用且不再维护。未建议替代包。

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

4.9.0 2021-07-16 12:00 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。