Laravel Guide

Install package

Publish configuration (optional)

Access your documentation

ByteDocs automatically detects all your routes! Just visit /docs to see your documentation.

// No setup required - just visit:
http://your-app.test/docs

// The package automatically:
// - Discovers all Laravel routes
// - Generates beautiful documentation
// - Provides AI assistance (if configured)

Add route annotations (optional)

Enhance your documentation with PHPDoc comments for better descriptions and parameter details.

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use App\Models\User;

class UserController extends Controller
{
    /**
     * Get all users with pagination support
     * @param page query integer false "Page number for pagination"
     * @param limit query integer false "Number of users per page"
     * @param search query string false "Search term to filter users"
     */
    public function index(Request $request)
    {
        return User::paginate($request->get('limit', 15));
    }

    /**
     * Create a new user account
     */
    public function store(Request $request)
    {
        return User::create($request->validated());
    }

    /**
     * Get user details by ID
     * @param id path integer true "User ID to retrieve"
     */
    public function show(User $user)
    {
        return $user;
    }
}

Configure AI integration (optional)

Enable AI assistance for your API documentation with support for multiple providers.

// Add to your .env file:
BYTEDOCS_AI_ENABLED=true
BYTEDOCS_AI_PROVIDER=openai  # or gemini, claude, openrouter
BYTEDOCS_AI_API_KEY=your-api-key-here
BYTEDOCS_AI_MODEL=gpt-4o-mini

// Or configure in config/bytedocs.php:
'ai' => [
    'enabled' => true,
    'provider' => 'openai',
    'api_key' => env('BYTEDOCS_AI_API_KEY'),
    'features' => [
        'chat_enabled' => true,
        'model' => 'gpt-4o-mini',
        'max_tokens' => 1000,
        'temperature' => 0.7,
    ],
],

Customize configuration

Configure base URLs, authentication, UI settings, and route detection modes.

// config/bytedocs.php
return [
    'title' => 'My API Documentation',
    'version' => '1.0.0',
    'description' => 'Comprehensive API for my application',

    'base_urls' => [
        ['name' => 'Production', 'url' => 'https://api.myapp.com'],
        ['name' => 'Staging', 'url' => 'https://staging-api.myapp.com'],
        ['name' => 'Local', 'url' => 'http://localhost:8000'],
    ],

    'docs_path' => '/docs',
    'auto_detect' => true,

    'route_detection' => [
        'mode' => 'api', // 'web', 'api', or 'both'
    ],

    'exclude_paths' => [
        '_ignition',
        'telescope',
        'horizon',
        'admin/*',
    ],

    'auth' => [
        'enabled' => false,
        'password' => env('BYTEDOCS_AUTH_PASSWORD'),
    ],

    'ui' => [
        'theme' => 'auto', // light, dark, auto
        'show_try_it' => true,
        'show_schemas' => true,
    ],
];