skills.rest
pimcore
pimcoreOFFICIAL
Explore all skills by this author →
Website𝕏@pimcoreGitHub

pimcore-studio-backend-controller

Standardize Pimcore Studio backend controllers with one-action-per-controller and OpenAPI routes.

13|Updated Apr 2, 2026
Search Tags:#openapi#backend#type-safety#controller-patterns#pimcore-studio#dto-binding#route-configuration
One-click install
npx skills add https://github.com/pimcore/skills --skill pimcore-studio-backend-controller
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pimcore-studio-backend-controller
Source: https://github.com/pimcore/skills/tree/main/skills/pimcore-studio-backend-controller
Command: npx skills add https://github.com/pimcore/skills --skill pimcore-studio-backend-controller

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Standardizes Pimcore Studio backend controllers to enforce the one-action-per-controller pattern and OpenAPI-compliant route definitions.

Core Features & Use Cases

  • One-action-per-controller classes for clean, maintainable code.
  • OpenAPI annotations and consistent route configuration across domains.
  • DTO-based parameter binding via MapQueryString and MapRequestPayload to enforce type-safety and validation.

Quick Start

Configure a new backend action controller by creating a dedicated class under a domain folder (e.g., Config/GetController) and applying the prescribed OpenAPI attributes, route constants, and DTO-based parameter bindings.

Frequently Asked Questions about pimcore-studio-backend-controller

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I standardize Pimcore Studio backend controllers for OpenAPI compliance?▼

DTO-based parameter binding uses MapQueryString and MapRequestPayload to enforce type-safety in Pimcore Studio controllers. It automatically validates incoming request data against strict Data Transfer Objects before your controller logic executes.

What is the one-action-per-controller pattern in backend route configuration?▼

Configure a new Pimcore Studio backend action by creating a dedicated final class under a domain folder. Apply prescribed OpenAPI attributes, define route constants, and implement DTO-based parameter bindings for type-safe request handling.

Does Pimcore Studio support automatic OpenAPI annotations for void response endpoints?▼

Yes, Pimcore Studio backend controllers support void and upload endpoints with proper Response handling and OpenAPI annotations. Controllers must be marked as final with @internal annotations to satisfy strict architectural requirements.

How does priority handling for literal segments work in Pimcore route configuration?▼

Priority handling for literal segments ensures OpenAPI-compliant route definitions correctly resolve static URL paths before dynamic parameters. This mechanism prevents routing conflicts and maintains strict route configuration across all backend domains.

Why should backend controllers use final classes and @internal annotations?▼

Final classes and @internal annotations enforce the single-service controller constraint and prevent unauthorized inheritance. This standardization guarantees that Pimcore Studio backend controllers remain isolated, maintainable, and strictly typed.

Related Skills

Explore More Software Engineering Skills→
tejovanthntejovanthn
1

zod-validation

Validate and infer TypeScript runtime data with Zod schemas.

Community
Intermediate
mikopbxmikopbx
569

openapi-analyzer

Extract and analyze OpenAPI 3.1.0 specifications to validate endpoints and generate tests.

Official
Advanced
jakubciszakjakubciszak
1

api-design

Design REST APIs for Symfony backends with OpenAPI specifications and DTO-based contracts.

Community
Intermediate
bxmaximumbxmaximum
33

bitrix-controllers

Automate Bitrix D7 controller development with parameter binding and ActionFilter security.

Community
Advanced