codise/laravel-apidoc-generator

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

5.1.1 2022-04-22 12:07 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 codise/laravel-apidoc-generator

Laravel

运行以下命令发布配置文件:

php artisan vendor:publish --provider="Codise\ApiDoc\ApiDocGeneratorServiceProvider" --tag=apidoc-config

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

Lumen

  • 当使用Lumen时,您需要运行composer require codise/laravel-apidoc-generator
  • 在您的bootstrap/app.php中注册服务提供者
$app->register(\Codise\ApiDoc\ApiDocGeneratorServiceProvider::class);
  • 将配置文件从vendor/codise/laravel-apidoc-generator/config/apidoc.php复制到您的项目中作为config/apidoc.php。然后将其添加到您的bootstrap/app.php
$app->configure('apidoc');

文档

请查看Beyond Code主页中的文档。

许可

Laravel API文档生成器是免费软件,许可证为MIT。