Luminous

Appearance

LuminousOpenAPI from your Laravel code

Generate OpenAPI 3.2 docs from PHP 8 Attributes. No YAML files to maintain. No docblocks to parse.

Get started
View on GitHub
Packagist
Luminous

Attributes, not YAML

Put a few PHP 8 attributes on your controllers. Luminous builds the full OpenAPI 3.2 spec automatically.

FormRequest rules drive request bodies

Request schemas follow your validation rules, so they stay up to date as your API changes.

Resources stay honest

Document API Resources with a schema() method next to toArray(), so response docs match what you return.

Ready-made UI

Swagger UI, Redoc, or Scalar at /docs. Export JSON or YAML for portals, linters, and SDK generators.

From attributes to a spec ​

The controller you already have, and the OpenAPI it becomes.

php
#[ApiTag('Payments')]
class PaymentController extends Controller
{
    #[ApiOperation('Create a payment')]
    #[ApiResponse(201, PaymentResource::class, 'Payment created')]
    #[ApiResponse(422, ErrorResource::class, 'Validation failed')]
    public function store(CreatePaymentRequest $request): JsonResponse
    {
        // ...
    }
}
yaml
/api/payments:
  post:
    tags: [Payments]
    summary: Create a payment
    requestBody:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreatePaymentRequest'
    responses:
      '201':
        description: Payment created
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentResource'
      '422':
        description: Validation failed
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ErrorResource'