README

Lightweight API documentation for Laravel.

Features

• Interactive API documentation
• Execute API requests directly from the browser
• Path parameters (/users/{id})
• JSON request bodies
• GET, POST, PUT, PATCH and DELETE support
• Search endpoints instantly
• Dark mode support
• Attribute-based documentation
• Lightweight and zero external dependencies

Installation

composer require guljahang/swaglite

Publish the package assets:

php artisan vendor:publish --tag=swaglite-assets

Access the Documentation

After installing the package, start your Laravel application and open:

http://localhost:8000/swaglite

Usage

Response Documentation

#[SwagResponse(
    status: 200,
    description: 'Success'
)]
public function index()
{
    return User::all();
}

Path Parameters

#[SwagParameter(
    name: 'id',
    in: 'path',
    required: true,
    example: 1
)]
public function show($id)
{
    return User::findOrFail($id);
}

Request Body

#[SwagParameter(
    name: 'name',
    in: 'body',
    required: true
)]
#[SwagParameter(
    name: 'email',
    in: 'body',
    required: true
)]
public function store(Request $request)
{
    return $request->all();
}

Supported Methods

• GET
• POST
• PUT
• PATCH
• DELETE

Screenshots

Light Mode

Dark Mode

License

MIT