> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/charlietyn/openapi-generator/llms.txt
> Use this file to discover all available pages before exploring further.

# Laravel OpenAPI Generator

> Automatic OpenAPI 3.0.3 documentation generator for Laravel with Postman and Insomnia export support

<div className="relative overflow-hidden bg-white border-2 border-[#e0e0e0] rounded-lg shadow-[0_2px_8px_rgba(0,0,0,0.05)] p-8 mb-8">
  <div className="relative z-10">
    <h1 className="text-5xl font-bold text-[#1a1a1a] mb-4" style={{ fontFamily: 'Inter', fontSize: '48px', fontWeight: 700 }}>
      Laravel OpenAPI Generator
    </h1>

    <p className="text-xl text-[#1a1a1a] mb-6" style={{ fontFamily: 'Inter', fontSize: '18px', fontWeight: 400 }}>
      Automatically generate OpenAPI 3.0.3 specifications, Postman collections, and Insomnia workspaces from your Laravel routes.
    </p>

    <div className="flex gap-4">
      <a href="/quickstart" className="inline-block px-6 py-3 bg-[#e6e6e6] text-[#1a1a1a] font-bold rounded-md hover:opacity-90 transition-opacity" style={{ borderRadius: '6px' }}>
        Get Started
      </a>

      <a href="https://github.com/charlietyn/openapi-generator" className="inline-block px-6 py-3 bg-transparent text-[#1a1a1a] font-bold border-2 border-[#1a1a1a] hover:bg-[#f5f5f5] transition-colors" style={{ borderRadius: '0px' }}>
        View on GitHub
      </a>
    </div>
  </div>
</div>

## Key Features

<CardGroup cols={2}>
  <Card title="OpenAPI 3.0.3 Generation" icon="file-code" href="/guides/basic-usage">
    Automatically generate OpenAPI specifications from your Laravel routes with full schema support
  </Card>

  <Card title="Postman Export" icon="paper-plane" href="/guides/basic-usage">
    Export complete Postman collections with environments for all your API endpoints
  </Card>

  <Card title="Insomnia Workspaces" icon="moon" href="/guides/basic-usage">
    Generate Insomnia workspaces with automated tests and multiple environments
  </Card>

  <Card title="Multi-API Support" icon="layer-group" href="/concepts/api-types">
    Organize routes by API type (admin, mobile, site) with independent filtering
  </Card>

  <Card title="Template-Based Docs" icon="file-lines" href="/guides/advanced-usage">
    Customize documentation with flexible templates and metadata extraction
  </Card>

  <Card title="HTTP Endpoints" icon="globe" href="/guides/basic-usage">
    Access generated documentation dynamically via HTTP endpoints
  </Card>
</CardGroup>

## Quick Start

<Steps>
  <Step title="Install the package">
    Install via Composer:

    ```bash theme={null}
    composer require ronu/laravel-openapi-generator
    ```
  </Step>

  <Step title="Publish configuration">
    Publish the configuration file (optional but recommended):

    ```bash theme={null}
    php artisan vendor:publish --tag=openapi-config
    ```
  </Step>

  <Step title="Generate documentation">
    Generate your first OpenAPI specification:

    ```bash theme={null}
    php artisan openapi:generate
    ```
  </Step>
</Steps>

## What You Can Generate

<Tabs>
  <Tab title="OpenAPI Spec">
    Generate OpenAPI 3.0.3 JSON or YAML specifications with full route metadata, request/response schemas, and authentication requirements.

    ```bash theme={null}
    php artisan openapi:generate --format=json
    ```
  </Tab>

  <Tab title="Postman Collection">
    Export Postman collections with pre-configured environments for local, staging, and production.

    ```bash theme={null}
    php artisan openapi:generate --with-postman
    ```
  </Tab>

  <Tab title="Insomnia Workspace">
    Create Insomnia workspaces with automated tests, environments, and API specifications.

    ```bash theme={null}
    php artisan openapi:generate --with-insomnia
    ```
  </Tab>

  <Tab title="All Formats">
    Generate everything at once for all API types.

    ```bash theme={null}
    php artisan openapi:generate --all
    ```
  </Tab>
</Tabs>

## Compatibility

<Info>
  **PHP**: 8.1, 8.2, 8.3\
  **Laravel**: 10.x, 11.x, 12.x\
  **Composer**: 2.x
</Info>

## Next Steps

<CardGroup cols={2}>
  <Card title="Installation Guide" icon="download" href="/installation">
    Detailed installation and setup instructions
  </Card>

  <Card title="Quickstart Tutorial" icon="rocket" href="/quickstart">
    Get up and running in 5 minutes
  </Card>

  <Card title="Core Concepts" icon="lightbulb" href="/concepts/overview">
    Learn about API types, environments, and templates
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/public-api">
    Explore the complete API documentation
  </Card>
</CardGroup>
