abanoubmagdyadly/laravel-apidoc-generator

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

3.17.1 2019-09-12 22:34 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 abanoubmagdyadly/laravel-apidoc-generator

Laravel

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

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

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

Lumen

  • 当使用 Lumen 时,您需要运行 composer require abanoubmagdyadly/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。