Habilidades allra-api-design
📦

allra-api-design

Seguro

Diseñar APIs de Allra Spring

Los equipos de backend necesitan una estructura de API, nombres de DTO, validación y patrones de respuesta consistentes. Esta skill guía a Claude, Codex y Claude Code para seguir las convenciones de Allra Spring Boot.

Soporta: Claude Codex Code(CC)
🥈 80 Plata
1

Descargar el ZIP de la skill

2

Subir en Claude

Ve a Configuración → Capacidades → Skills → Subir skill

3

Activa y empieza a usar

Recursos legibles por agentes

Usa estos enlaces cuando un AI Agent, crawler o script necesite contexto limpio en lugar de leer toda la página.

Detalle Markdown GET /skills/allra-fintech-allra-api-design.md Manifest firmado GET /api/skills/allra-fintech-allra-api-design/manifest Lockfile firmado GET /api/skills/allra-fintech-allra-api-design/lockfile

Pruébalo

Usando "allra-api-design". Diseña una API de creación de producto.

Resultado esperado:

La respuesta describiría un paquete de dominio de producto, una solicitud de creación, una respuesta de producto, necesidades de validación y una ruta de controlador para la creación de producto.

Usando "allra-api-design". Revisa los nombres UserSignUpEventDto y SignUpResponse.

Resultado esperado:

La respuesta clasificaría el objeto de evento como un DTO interno y el resultado del registro como un objeto de respuesta para el cliente.

Usando "allra-api-design". Comprueba si una API de actualización de usuario sigue la lista de verificación.

Resultado esperado:

La respuesta compararía el diseño con la estructura de paquetes, la nomenclatura de DTO, el uso de record, la validación, la nomenclatura REST y las reglas de sufijo para DTO internos.

Auditoría de seguridad

Seguro
v6 • 6/28/2026

Static analysis reported external command, weak cryptography, and reconnaissance patterns in SKILL.md. Manual review found these are false positives from Markdown code fences, inline examples, and descriptive text. No executable scripts, network access, filesystem access, prompt injection, or malicious intent were found.

1
Archivos escaneados
269
Líneas analizadas
3
hallazgos
6
Auditorías totales
Problemas de riesgo bajo (3)
SKILL.md:24-32SKILL.md:34SKILL.md:38-55SKILL.md:61-64SKILL.md:68-71SKILL.md:77-96SKILL.md:102-137SKILL.md:139SKILL.md:145-158SKILL.md:165-181SKILL.md:199-236SKILL.md:240-257
False Positive: Markdown Backtick Examples
FALSE_POSITIVE. The external command detections are Markdown code fences and inline formatting for package trees, DTO names, Java examples, JSON examples, and checklist text. They are documentation examples, not shell execution instructions or runnable skill scripts.
SKILL.md:2-3
False Positive: Weak Cryptography Match
FALSE_POSITIVE. The weak cryptography detections at the front matter are text matches in the skill name and description. They do not define or recommend DES, MD5, SHA1, or any other weak algorithm.
SKILL.md:117SKILL.md:123SKILL.md:130SKILL.md:135SKILL.md:231
False Positive: REST Controller Examples
FALSE_POSITIVE. The system reconnaissance detections are Spring controller examples using request bodies and path variables. They describe API design conventions and do not collect host, user, network, or environment information.
Auditado por: codex Ver historial de auditorías →

Puntuación de calidad

55
Arquitectura
100
Mantenibilidad
87
Contenido
70
Comunidad
99
Seguridad
83
Cumplimiento de la especificación

Lo que puedes crear

Crear una nueva API de dominio

Planificar carpetas de paquetes, endpoints de controlador, DTOs de solicitud, DTOs de respuesta y límites de servicio para un nuevo dominio de Spring.

Estandarizar la nomenclatura de DTO

Revisar los nombres de DTOs de solicitud, respuesta, transferencia interna, resultado de consulta y evento frente a las expectativas de nomenclatura de Allra.

Preparar tareas de implementación de API

Convertir una solicitud de funcionalidad en una lista de verificación de implementación alineada con las convenciones de REST y validación de Allra.

Prueba estos prompts

Planificar una API simple 
Usa las reglas de diseño de API de Allra para planificar una nueva API de Spring Boot para [domain]. Incluye la estructura de paquetes, los nombres de endpoints y los nombres de DTO.
Revisar nombres de DTO 
Revisa estos nombres de DTO según las convenciones de Allra: [names]. Identifica cuáles deberían ser tipos Request, Response o Dto internos.
Diseñar reglas de validación 
Diseña la validación de DTO de solicitud para [operation]. Sigue la guía de Allra para Spring Bean Validation y explica cada campo requerido.
Auditar un diseño de API 
Evalúa este diseño de API de Spring frente a los estándares de paquetes, DTO, controlador, respuesta y lista de verificación de Allra. Proporciona correcciones concretas: [design].

Mejores prácticas

  • Empieza por la estructura de paquetes de dominio antes de nombrar clases.
  • Mantén separados los DTOs de cliente y los DTOs internos mediante la nomenclatura y la ubicación del paquete.
  • Aplica validación a cada DTO de solicitud que reciba entrada del cliente.

Evitar

  • Mezclar código de controlador, entidad, repositorio y servicio en un solo paquete.
  • Usar DTOs internos como contratos de respuesta de API pública.
  • Crear DTOs de solicitud sin validación para campos de cliente requeridos.

Preguntas frecuentes

¿Para qué framework está diseñada esta skill?
Está diseñada para Java 17 o posterior con Spring Boot 3.2 o posterior.
¿Esta skill crea código de aplicación ejecutable?
Proporciona convenciones y ejemplos. El asistente puede usarlos al crear código, pero la skill en sí es documentación.
¿Pueden usarla equipos que no sean de Allra?
Sí, pero los equipos deberían adaptar la nomenclatura, los formatos de respuesta y las reglas de paquetes a sus propios estándares.
¿Incluye diseño de esquema de base de datos?
No. Menciona repositorios y entidades, pero no define reglas de esquema de base de datos.
¿Cubre el versionado de API?
Muestra rutas versionadas como ejemplo e indica que el versionado depende de la política del proyecto.
¿Qué asistentes pueden usar esta skill?
El informe indica soporte para Claude, Codex y Claude Code.

Detalles del desarrollador

Licencia

MIT

Repositorio

https://github.com/Allra-Fintech/allra-ai-skills/tree/main/backend-plugin/skills/api-design

Ref.

main

Estructura de archivos

📄 SKILL.md