cuihao777/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和Laravel 5.5或更高版本。

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 中的文档。

许可证

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