Download the PHP package organiseyou/openapi-generator without Composer

OpenApiGenerator

A lightweight, fluent PHP service for generating OpenAPI 3.0.0 specifications programmatically. Perfect for Laravel and standalone PHP applications.

Installation

Quick Start

Core Features

Schemas

Define reusable data structures with the schema() method:

Dynamic Properties with Loops

Add properties dynamically from arrays or databases:

Endpoints with Full Documentation

Define API endpoints with parameters, request bodies, and responses:

POST with Request Body

Multiple Methods on Same Path

Reusable Response Components

Output Formats

JSON Output

Generate Array

YAML Output

Requires symfony/yaml:

Laravel Integration

Service Provider Setup

Create a route to serve your API documentation:

In a Service Class

Then use it in a controller:

Complete Example

API Reference

OpenApiService

• addPath(string $path, string $method, array $operation): self
• addSchema(string $name, array $schema): self
• addResponse(string $name, array $response): self
• path(string $path): PathBuilder
• schema(string $name): SchemaBuilder
• generate(): array
• toJson(int $flags = JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT): string
• toYaml(): string

PathBuilder

• method(string $method): self
• summary(string $summary): self
• description(string $description): self
• tags(array $tags): self
• parameters(array $parameters): self
• requestBody(array $content, bool $required = true): self
• response(int|string $status, array $response): self
• register(): OpenApiService

SchemaBuilder

• type(string $type): self
• property(string $name, string $type, array $options = []): self
• required(array $fields): self
• description(string $description): self
• example(array $example): self
• register(): OpenApiService

License

MIT