Skip to main content

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

Automatically generate OpenAPI 3.0.3 specifications, Postman collections, and Insomnia workspaces from your Laravel routes.

Get StartedView on GitHub

​
Key Features

OpenAPI 3.0.3 Generation

Automatically generate OpenAPI specifications from your Laravel routes with full schema support

Postman Export

Export complete Postman collections with environments for all your API endpoints

Insomnia Workspaces

Generate Insomnia workspaces with automated tests and multiple environments

Multi-API Support

Organize routes by API type (admin, mobile, site) with independent filtering

Template-Based Docs

Customize documentation with flexible templates and metadata extraction

HTTP Endpoints

Access generated documentation dynamically via HTTP endpoints

​
Quick Start

1

Install the package

Install via Composer:
composer require ronu/laravel-openapi-generator
2

Publish configuration

Publish the configuration file (optional but recommended):
php artisan vendor:publish --tag=openapi-config
3

Generate documentation

Generate your first OpenAPI specification:
php artisan openapi:generate

​
What You Can Generate

Generate OpenAPI 3.0.3 JSON or YAML specifications with full route metadata, request/response schemas, and authentication requirements.
php artisan openapi:generate --format=json

​
Compatibility

PHP: 8.1, 8.2, 8.3
Laravel: 10.x, 11.x, 12.x
Composer: 2.x

​
Next Steps

Installation Guide

Detailed installation and setup instructions

Quickstart Tutorial

Get up and running in 5 minutes

Core Concepts

Learn about API types, environments, and templates

API Reference

Explore the complete API documentation

Build docs developers (and LLMs) love

Get started for freeTalk to us