Skip to content

Resource

Resource shapes reusable HTTP fields from Models, DTOs, and Value Objects.

Generated facts

Layer
service
Generated path
app/Pulsar/Services/{Service}/Modules/{Module}/Resources/{Name}.php
Generator command
make:resource
Workflow method
None
Stability
Current manifest surface (Pulsar 0.4.1)

Canonical example

Generated src/stubs/resource-collection.stub — canonical synchronized stub.

<?php

namespace {{namespace}};

use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\JsonResource;

class {{name}} extends JsonResource
{
    /**
     * @return array<string, mixed>
     */
    public function toArray(Request $request): array
    {
        // Shape Models, DTOs, and Value Objects here. Never shape HTTP responses in Domain.
        return [
            //
        ];
    }
}

Responsibility

Resource owns the responsibility stated above; it must not absorb delivery, transaction, or unrelated cross-layer behavior.

Placement and dependencies

Keep this type in its generated Service Module path. It may depend inward on Domain capability, but it must not make another Service its behavioral dependency.

Workflow and tests

Resource is consumed by the owning Domain or Service workflow and returns a delivery-neutral result. Test its direct contract, its rejected boundary cases, and the caller or callee that proves the rule in application flow.

Three pitfalls

  1. ❌ Prohibited: move this responsibility into a neighboring type merely because it is nearby.
  2. ✅ Correct: keep the generated placement and depend only on the documented layer direction.
  3. ✅ Correct: test the boundary through the caller and the return or side effect visible to its callee.

Related reading

Read architecture placement for shared rationale and follow this page’s related concept links for the adjacent responsibility.

Boundaries

❌ Prohibited: Do not return HTTP response objects from Domain types.

✅ Correct: Use a Resource for reusable field shaping and keep top-level response assembly in a Controller.