PHP code example of piovezanfernando / laravel-api-auto-docs

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

piovezanfernando / laravel-api-auto-docs example snippets

class UserController extends Controller
{
    /**
     * Create a new user.
     *
     * This endpoint allows you to create a new user in the system.
     * The user's name, email, and password are 

class CreateUserRequest extends FormRequest
{
    public function rules()
    {
        return [
            'name' => ' }
}

'hide_matching' => [
    '#^api/internal#',
    '#^_debugbar#',
],

'middlewares' => [
    'web',
    'auth', // Add if you want authentication
],

'title' => 'My API Documentation',
'default_headers' => [
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
],

// config/api-auto-docs.php
'middlewares' => [
    'web',
    'auth',
    'can:view-api-docs', // Custom gate
],

bash
php artisan vendor:publish --tag="api-auto-docs-config"

bash
php artisan api-docs:export

bash
php artisan api-docs:export storage/app/api.json