joeri-abbo/laravel-api-markdown-tree

There is no license information available for the latest version (dev-master) of this package.

A Laravel package to generate a tree view of API routes in Markdown format.

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

Requires

• php: ^7.4|^8.0
• illuminate/support: ^8.0|^9.0|^10.0

Requires (Dev)

• mockery/mockery: ^1.5.0
• orchestra/testbench: ^8.0.0
• phpunit/phpunit: ^10.0.0

Unknown License

README

Laravel API Markdown Tree is a package for generating API documentation in a tree view Markdown format based on your Laravel application's routes.

Installation

To install the package as a development dependency, follow these steps:

1. Add the package repository to your Laravel project's composer.json file:

"repositories": [
{
"type": "vcs",
"url": "https://github.com/JoeriAbbo/laravel-api-markdown-tree.git"
}
],

Make sure to replace the URL with the URL of your Git repository.

1. Require the package in your Laravel project as a development dependency:

   composer require --dev joeriabbo/laravel-api-markdown-tree: dev-master

1. If you're using Laravel 5.4 or earlier, register the service provider in your config/app.php file:

'providers' => [
    // ...
    JoeriAbbo\LaravelApiMarkdownTree\LaravelApiMarkdownTreeServiceProvider::class,
],

For Laravel 5.5 or later, the service provider will be auto-discovered.

Usage

To generate API documentation, run the following command in your Laravel project's root directory:

php artisan apidocs:generate

By default, this command will create a api_docs.md file in your Laravel project root directory with the tree view of the API routes in Markdown format. You can specify a custom output file by passing it as an argument, like this:

php artisan apidocs:generate custom_output.md

License This package is open-source software licensed under the MIT license.