Habilidades api-design-principles
🧭
api-design-principles
Seguro 🌐
Acceso a red⚙️
Comandos externos
Diseña APIs REST y GraphQL con confianza
Las decisiones de diseño de API a menudo se vuelven inconsistentes y difíciles de mantener. Esta habilidad proporciona patrones claros, plantillas y listas de verificación para guiar tus decisiones.
Soporta: Claude Codex Code(CC)
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
Pruébalo
Usando "api-design-principles". Revisa mis puntos de acceso de usuario y orden para mejores prácticas REST.
Resultado esperado:
- Usa sustantivos plurales: /api/users y /api/orders
- Reemplaza rutas de acción como /api/createUser con POST /api/users
- Agrega paginación a puntos de acceso de lista con page y page_size
- Devuelve 201 Created en POST exitoso y 204 en DELETE
Usando "api-design-principles". ¿Cómo debería estructurar un esquema GraphQL para un blog con usuarios, publicaciones y comentarios?
Resultado esperado:
- Define tipos User, Post, Comment con relaciones apropiadas
- Usa paginación con cursor estilo Relay para colecciones
- Crea tipos de entrada para mutaciones con cargas de error
- Agrega DataLoaders para prevenir consultas N+1 en relaciones
Usando "api-design-principles". ¿Qué códigos de estado debería devolver mi API para errores de validación?
Resultado esperado:
- Devuelve 400 Bad Request para sintaxis de solicitud malformada
- Devuelve 422 Unprocessable Entity para fallos de validación
- Incluye detalles de error a nivel de campo en el cuerpo de respuesta
- Usa formato de error consistente en todos los puntos de acceso
Auditoría de seguridad
Segurov4 • 1/17/2026
This skill contains only educational documentation, code templates, and best practices for API design. All 233 static findings are false positives: 'weak cryptographic algorithm' flags educational password hashing examples; 'backtick execution' misinterprets markdown code formatting; 'system reconnaissance' triggers on legitimate programming terms like fetch/decode; hardcoded URLs/IPs are documentation examples, not actual network calls. No executable code, network calls, or data access patterns pose security risks.
6
Archivos escaneados
2,011
Líneas analizadas
2
hallazgos
4
Auditorías totales
Factores de riesgo
🌐 Acceso a red (7)
⚙️ Comandos externos (134)
references/graphql-schema-design.md:6-35 references/graphql-schema-design.md:35-40 references/graphql-schema-design.md:40-48 references/graphql-schema-design.md:48-51 references/graphql-schema-design.md:51-72 references/graphql-schema-design.md:72-75 references/graphql-schema-design.md:75-99 references/graphql-schema-design.md:99-102 references/graphql-schema-design.md:102-122 references/graphql-schema-design.md:122-127 references/graphql-schema-design.md:127-171 references/graphql-schema-design.md:171-174 references/graphql-schema-design.md:174-185 references/graphql-schema-design.md:185-190 references/graphql-schema-design.md:190-212 references/graphql-schema-design.md:212-215 references/graphql-schema-design.md:215-231 references/graphql-schema-design.md:231-234 references/graphql-schema-design.md:234-254 references/graphql-schema-design.md:254-259 references/graphql-schema-design.md:259-296 references/graphql-schema-design.md:296-299 references/graphql-schema-design.md:299-314 references/graphql-schema-design.md:314-318 references/graphql-schema-design.md:318-343 references/graphql-schema-design.md:343-347 references/graphql-schema-design.md:347-364 references/graphql-schema-design.md:364-369 references/graphql-schema-design.md:369-388 references/graphql-schema-design.md:388-391 references/graphql-schema-design.md:391-404 references/graphql-schema-design.md:404-409 references/graphql-schema-design.md:409-452 references/graphql-schema-design.md:452-455 references/graphql-schema-design.md:455-474 references/graphql-schema-design.md:474-479 references/graphql-schema-design.md:479-493 references/graphql-schema-design.md:493-496 references/graphql-schema-design.md:496-507 references/graphql-schema-design.md:507-510 references/graphql-schema-design.md:510-520 references/graphql-schema-design.md:520-525 references/graphql-schema-design.md:525-531 references/graphql-schema-design.md:531-534 references/graphql-schema-design.md:534-553 references/graphql-schema-design.md:553-562 references/rest-best-practices.md:6-16 references/rest-best-practices.md:16-19 references/rest-best-practices.md:19-28 references/rest-best-practices.md:28-33 references/rest-best-practices.md:33-37 references/rest-best-practices.md:37-40 references/rest-best-practices.md:40-50 references/rest-best-practices.md:50-53 references/rest-best-practices.md:53-60 references/rest-best-practices.md:60-63 references/rest-best-practices.md:63-68 references/rest-best-practices.md:68-71 references/rest-best-practices.md:71-76 references/rest-best-practices.md:76-81 references/rest-best-practices.md:81-97 references/rest-best-practices.md:97-102 references/rest-best-practices.md:102-113 references/rest-best-practices.md:113-116 references/rest-best-practices.md:116-125 references/rest-best-practices.md:125-128 references/rest-best-practices.md:128-136 references/rest-best-practices.md:136-141 references/rest-best-practices.md:141-147 references/rest-best-practices.md:147-150 references/rest-best-practices.md:150-156 references/rest-best-practices.md:156-159 references/rest-best-practices.md:159-164 references/rest-best-practices.md:164-169 references/rest-best-practices.md:169-177 references/rest-best-practices.md:177-180 references/rest-best-practices.md:180-217 references/rest-best-practices.md:217-222 references/rest-best-practices.md:222-227 references/rest-best-practices.md:227-230 references/rest-best-practices.md:230-232 references/rest-best-practices.md:232-237 references/rest-best-practices.md:237-253 references/rest-best-practices.md:253-256 references/rest-best-practices.md:256-257 references/rest-best-practices.md:257-258 references/rest-best-practices.md:258-259 references/rest-best-practices.md:259-260 references/rest-best-practices.md:260-261 references/rest-best-practices.md:261-262 references/rest-best-practices.md:262-263 references/rest-best-practices.md:263-264 references/rest-best-practices.md:264-265 references/rest-best-practices.md:265-266 references/rest-best-practices.md:266-267 references/rest-best-practices.md:267-272 references/rest-best-practices.md:272-283 references/rest-best-practices.md:283-288 references/rest-best-practices.md:288-304 references/rest-best-practices.md:304-309 references/rest-best-practices.md:309-315 references/rest-best-practices.md:315-319 references/rest-best-practices.md:319-329 references/rest-best-practices.md:329-333 references/rest-best-practices.md:333-362 references/rest-best-practices.md:362-366 references/rest-best-practices.md:366-385 SKILL.md:31 SKILL.md:32 SKILL.md:33 SKILL.md:34 SKILL.md:35 SKILL.md:54-57 SKILL.md:57-60 SKILL.md:60-62 SKILL.md:62-65 SKILL.md:65-67 SKILL.md:67-73 SKILL.md:73-90 SKILL.md:90-94 SKILL.md:94-151 SKILL.md:151-155 SKILL.md:155-212 SKILL.md:212-216 SKILL.md:216-242 SKILL.md:242-248 SKILL.md:248-349 SKILL.md:349-353 SKILL.md:353-442 SKILL.md:442-446 SKILL.md:446-487 SKILL.md:487-492 SKILL.md:492 SKILL.md:492-506
Auditado por: claude Ver historial de auditorías →
Puntuación de calidad
55
Arquitectura
90
Mantenibilidad
85
Contenido
21
Comunidad
100
Seguridad
87
Cumplimiento de la especificación
Lo que puedes crear
Definir nuevos estándares de API
Crear reglas consistentes de REST y GraphQL para un equipo antes de la implementación.
Revisar especificaciones de API
Auditar especificaciones para problemas de nomenclatura, versionado y manejo de errores.
Mejorar la usabilidad de API
Refinar puntos de acceso y esquema para reducir confusión y retrabajo del cliente.
Prueba estos prompts
Revisión de conceptos básicos de REST
Revisa este esquema de API REST y enumera las correcciones de nomenclatura, métodos y códigos de estado. Proporciona un ejemplo corregido breve.
Verificación de esquema GraphQL
Evalúa este esquema de GraphQL para paginación, tipos de entrada y patrones de error. Sugiere mejoras con ejemplos breves.
Estrategia de versionado
Recomienda un enfoque de versionado para esta API y explica los intercambios. Proporciona una lista de verificación de migración.
Ejecutar lista de verificación de diseño
Aplica una lista de verificación de diseño de API a esta especificación y devuelve pasa o falla con correcciones para cada elemento fallido.
Mejores prácticas
- Documenta reglas de versionado y deprecación antes del lanzamiento
- Usa formatos de error consistentes con códigos de error estables
- Pagina todos los puntos de acceso de colección con límites claros
Evitar
- Usar POST para operaciones de solo lectura
- Rutas de recursos anidadas profundamente más allá de dos niveles
- Devolver formas de error inconsistentes entre puntos de acceso
Preguntas frecuentes
¿Es compatible con Claude, Codex y Claude Code?
Sí. La guía es agnóstica de plataforma y funciona en Claude, Codex y Claude Code.
¿Cuáles son los límites de esta habilidad?
Proporciona patrones y plantillas pero no genera un servicio de API completamente funcional.
¿Puedo integrar esto con mi base de código existente?
Sí. Usa la lista de verificación y plantillas para alinear tus puntos de acceso y esquema existentes.
¿Accede o almacena datos sensibles?
No. Solo proporciona orientación estática y ejemplos.
¿Y si mi diseño de API no está cubierto?
Proporciona tu especificación y objetivos, luego solicita recomendaciones específicas.
¿Cómo se compara con advice genérico de API?
Incluye patrones concretos de REST y GraphQL con listas de verificación y plantillas.
Detalles del desarrollador
Autor
wshobsonLicencia
NOASSERTION
Repositorio
https://github.com/wshobson/agents/tree/main/plugins/backend-development/skills/api-design-principlesRef.
main
Estructura de archivos