joeri-abbo/laravel-api-markdown-tree

此包的最新版本（dev-master）没有可用的许可证信息。

一个Laravel包，用于生成Markdown格式的API路由树视图。

维护者

详细信息

github.com/Joeri-Abbo/laravel-api-markdown-tree

源代码

问题

安装: 3

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

dev-master 2023-09-18 17:48 UTC

Requires

Requires (Dev)

Unknown License d1c7a5e287aef36a299e78fd98ed0145a39fdd2e

This package is auto-updated.

Last update: 2024-09-18 20:14:45 UTC

README

Laravel API Markdown Tree是一个包，用于基于您的Laravel应用程序的路由生成Markdown格式的树形视图API文档。

安装

要将该包作为开发依赖项安装，请按照以下步骤操作

  1. 将包仓库添加到您的Laravel项目的composer.json文件中
"repositories": [
{
"type": "vcs",
"url": "https://github.com/JoeriAbbo/laravel-api-markdown-tree.git"
}
],

请确保将URL替换为您Git仓库的URL。

  1. 将包作为开发依赖项添加到您的Laravel项目中
   composer require --dev joeriabbo/laravel-api-markdown-tree: dev-master
  1. 如果您使用的是Laravel 5.4或更早版本，请在config/app.php文件中注册服务提供者
'providers' => [
    // ...
    JoeriAbbo\LaravelApiMarkdownTree\LaravelApiMarkdownTreeServiceProvider::class,
],

对于Laravel 5.5或更高版本，服务提供者将自动发现。

使用方法

要生成API文档，请在您的Laravel项目根目录中运行以下命令

php artisan apidocs:generate

默认情况下，此命令将在您的Laravel项目根目录中创建一个api_docs.md文件，其中包含API路由的Markdown格式的树形视图。您可以通过传递参数来指定自定义输出文件，例如

php artisan apidocs:generate custom_output.md

许可证此包是开源软件，许可协议为MIT。