AgentSkillsCN

acc-create-dto

为 PHP 8.5 生成 DTO(数据传输对象)。为各层边界、API 请求/响应以及数据序列化创建不可变对象,并附带单元测试。

SKILL.md
--- frontmatter
name: acc-create-dto
description: Generates DTO (Data Transfer Object) for PHP 8.5. Creates immutable objects for layer boundaries, API requests/responses, and data serialization. Includes unit tests.

DTO Generator

Generate DTOs for transferring data between layers, API boundaries, and external systems.

DTO Characteristics

  • Immutable: Read-only after creation
  • No Behavior: Pure data container, no business logic
  • Serializable: JSON/array conversion support
  • Typed: Strictly typed properties
  • Validated: Input validation at creation (for requests)
  • Layer-Specific: Different DTOs for different purposes

DTO Types

TypePurposeLocation
Request DTOAPI input validationPresentation layer
Response DTOAPI output formattingPresentation layer
Command DTOUse case inputApplication layer
Query Result DTORead model outputApplication layer
Integration DTOExternal API dataInfrastructure layer

Generation Process

Step 1: Identify DTO Type

Determine the purpose and layer for the DTO.

Step 2: Generate DTO Class

Path based on type:

  • Request: src/Presentation/Api/{Context}/Request/
  • Response: src/Presentation/Api/{Context}/Response/
  • Application: src/Application/{Context}/DTO/
  • Integration: src/Infrastructure/ExternalApi/{Service}/DTO/

Step 3: Add Conversion Methods

  1. fromArray() — Create from raw data
  2. fromEntity() — Create from domain entity (Response DTOs)
  3. toArray() / jsonSerialize() — Serialize for output

Step 4: Generate Tests

Path: tests/Unit/{Layer}/{Context}/{Type}/


File Placement

TypePath
Request DTOsrc/Presentation/Api/{Context}/Request/
Response DTOsrc/Presentation/Api/{Context}/Response/
Application DTOsrc/Application/{Context}/DTO/
Integration DTOsrc/Infrastructure/ExternalApi/{Service}/DTO/
Unit Teststests/Unit/{Layer}/{Context}/{Type}/

Naming Conventions

TypePatternExample
Request{Action}{Entity}RequestCreateOrderRequest, UpdateUserRequest
Response{Entity}ResponseOrderResponse, UserResponse
Collection{Entity}CollectionResponseOrderCollectionResponse
Application{Entity}DTOUserDTO, OrderDTO
Integration{Service}{Action}ResponsePaymentGatewayResponse

Quick Template Reference

Request DTO

php
final readonly class {Name}Request
{
    public function __construct(
        #[Assert\NotBlank]
        public string $field,
        #[Assert\Valid]
        public ?NestedRequest $nested = null
    ) {}

    public static function fromArray(array $data): self;
}

Response DTO

php
final readonly class {Name}Response implements \JsonSerializable
{
    public function __construct(
        public string $id,
        public string $name,
        /** @var array<ItemResponse> */
        public array $items = []
    ) {}

    public static function fromEntity({Entity} $entity): self;
    public function jsonSerialize(): array;
}

Application DTO

php
final readonly class {Name}DTO
{
    public function __construct(
        public string $id,
        public string $field
    ) {}

    public static function fromRequest({Name}Request $request): self;
    public function toArray(): array;
}

Anti-patterns to Avoid

Anti-patternProblemSolution
Business LogicDTO with calculationsKeep DTOs data-only
Mutable DTOsetters, state changesUse readonly, immutable
Domain ObjectsReturning entities from APIMap to Response DTO
Anemic ValidationNo input validationUse Assert attributes
Deep NestingComplex nested DTOsFlatten or split
Missing SerializationNo JSON supportImplement JsonSerializable

References

For complete PHP templates and examples, see:

  • references/templates.md — Request, Response, Application, Collection, Integration DTO templates
  • references/examples.md — Order, User, Payment examples and tests