Habilidades api-design-framework

📦

api-design-framework

Name: api-design-framework
Author: AI Agent Hub

v1.0.0 Revisión del contenido r2 Seguro ⚙️ Comandos externos🌐 Acceso a red

Diseña contratos de API listos para producción

Los equipos a menudo diseñan APIs con recursos, errores y versionado inconsistentes. Esta skill proporciona patrones, listas de verificación y plantillas para trabajos con REST, GraphQL, gRPC, OpenAPI y AsyncAPI.

Compatible con: Claude Codex Code(CC)

🥈 80 Plata

Maintain this Skill? Claim it 🥈 80 Plata

Instalar con mi Agente

Copia esta solicitud en tu Agente. Incluye la página canónica del Skill y el manifiesto.

Solicitud de agente

Review the Skillstore skill "api-design-framework" from https://skillstore.io/skills/ariegoldkin-api-design-framework.md and its manifest at https://skillstore.io/api/skills/ariegoldkin-api-design-framework/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

Tu Agente debe seguir mostrando su plan y solicitar cualquier confirmación exigida por la política de seguridad.

Recursos legibles por agentes

Usa estos enlaces cuando un agente de IA, crawler o script necesite contexto limpio en vez de leer la página completa.

Detalle Markdown GET /skills/ariegoldkin-api-design-framework.md Manifest firmado GET /api/skills/ariegoldkin-api-design-framework/manifest Lockfile firmado GET /api/skills/ariegoldkin-api-design-framework/lockfile

Pruébalo

Usando "api-design-framework". Solicitud: Diseñar una API de usuarios para gestión de cuentas.

Resultado esperado:

Un modelo de recursos con endpoints de usuario, métodos HTTP, códigos de estado, reglas de paginación y orientación sobre errores de validación estructurados.

Usando "api-design-framework". Solicitud: Decidir entre REST y GraphQL para un panel.

Resultado esperado:

Una comparación de flexibilidad de consultas, almacenamiento en caché, complejidad del cliente y gobernanza.
Una recomendación basada en las necesidades de los consumidores y las restricciones operativas.

Usando "api-design-framework". Solicitud: Preparar documentación de eventos para el procesamiento de pedidos.

Resultado esperado:

Un mapa de eventos orientado a AsyncAPI con canales, nombres de mensajes, conceptos de payload, esquemas de seguridad y expectativas de reintento.

Auditoría de seguridad

Seguro

v9 • 23/7/2026 Abrir el informe versionado

All 113 static findings are false positives caused by Markdown backticks, API identifiers, and illustrative URLs in documentation and templates. The files contain no executable commands, runtime network requests, system reconnaissance instructions, or prompt injection text. No semantic security issue was found.

Archivos escaneados

2,047

Líneas analizadas

Elementos de revisión

Falsos positivos ignorados

Factores de riesgo

⚙️ Comandos externos (50)

SKILL.md:59-67 SKILL.md:67-70 SKILL.md:70-77 SKILL.md:77-80 SKILL.md:80-88 SKILL.md:88-94 SKILL.md:94-95 SKILL.md:95-96 SKILL.md:96-97 SKILL.md:97-98 SKILL.md:98-99 SKILL.md:99-100 SKILL.md:100-108 SKILL.md:108-131 SKILL.md:131-140 SKILL.md:140-143 SKILL.md:143-156 SKILL.md:156-159 SKILL.md:159-183 SKILL.md:183-188 SKILL.md:188-199 SKILL.md:199-205 SKILL.md:205-218 SKILL.md:218-226 SKILL.md:226-229 SKILL.md:229-232 SKILL.md:232-236 SKILL.md:236-239 SKILL.md:239-242 SKILL.md:242-247 SKILL.md:247-253 SKILL.md:253-256 SKILL.md:256-262 SKILL.md:262-265 SKILL.md:265-270 SKILL.md:270-277 SKILL.md:277-294 SKILL.md:294-299 SKILL.md:299-302 SKILL.md:302-305 SKILL.md:305-308 SKILL.md:308-311 SKILL.md:311-314 SKILL.md:314-323 SKILL.md:323-330 SKILL.md:330-333 SKILL.md:333-355 SKILL.md:355-358 SKILL.md:358-379 SKILL.md:379-384

🌐 Acceso a red (14)

SKILL.md:616 templates/asyncapi-template.yaml:80 templates/asyncapi-template.yaml:17 templates/asyncapi-template.yaml:21 templates/asyncapi-template.yaml:542 templates/openapi-template.yaml:22 templates/openapi-template.yaml:26 templates/openapi-template.yaml:28 templates/openapi-template.yaml:31 templates/openapi-template.yaml:33 templates/openapi-template.yaml:35 templates/openapi-template.yaml:308 templates/openapi-template.yaml:344 templates/openapi-template.yaml:370

La auditoría estática y semántica completada más reciente no detectó hallazgos de seguridad confirmados. Esto no demuestra que el skill no tenga efectos secundarios.

Auditado por: codex Ver historial de auditorías →

Compartir y citar este informe

Comparte el informe de evaluación versionado, la insignia neutral, la tarjeta insertable y las citas. Skillstore presenta evidencias sin decidir si este Skill es seguro.

Abrir el informe versionado

Copiar enlace del informe

https://skillstore.io/skills/ariegoldkin-api-design-framework/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Insignia Markdown

[![Skillstore security assessment](https://skillstore.io/badges/skills/ariegoldkin-api-design-framework/security.svg)](https://skillstore.io/skills/ariegoldkin-api-design-framework?utm_source=security_passport_badge)

Insignia HTML

<a href="https://skillstore.io/skills/ariegoldkin-api-design-framework?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/ariegoldkin-api-design-framework/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

Tarjeta para insertar

<iframe src="https://skillstore.io/embed/skills/ariegoldkin-api-design-framework.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>

Citas académicas (APA · BibTeX · CFF)

Cita APA

AI Agent Hub. (2026). api-design-framework security audit report (audit version 9) [Author version 1.0.0]. Skillstore. https://skillstore.io/skills/ariegoldkin-api-design-framework/audits/9

Cita BibTeX

@techreport{ai-agent-hub-ariegoldkin-api-design-framework-2026,
  author = {AI Agent Hub},
  title = {api-design-framework security audit report (audit version 9)},
  institution = {Skillstore},
  year = {2026},
  number = {9},
  url = {https://skillstore.io/skills/ariegoldkin-api-design-framework/audits/9},
  note = {Author version 1.0.0}
}

CITATION.cff

cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "api-design-framework security audit report (audit version 9)"
version: "1.0.0"
type: report
authors:
  - name: "AI Agent Hub"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/ariegoldkin-api-design-framework/audits/9"
identifiers:
  - type: other
    value: "skillstore:ariegoldkin-api-design-framework:audit:9"
    description: "Skillstore immutable audit report identifier"

Puntuación de Skillstore

Por qué esta puntuación Confianza de la evidencia: Alto

Arquitectura

100

Mantenibilidad

Contenido

Comunidad

Cumplimiento de la especificación

Lo que puedes crear

Diseñar un nuevo contrato de servicio

Definir recursos, métodos, errores, paginación y autenticación antes de que comience la implementación.

Estandarizar la gobernanza de API

Crear convenciones compartidas para REST, GraphQL, gRPC, OpenAPI y AsyncAPI entre equipos.

Revisar la preparación de una API para lanzamiento

Comprobar versionado, documentación, manejo de errores, límites de tasa y planes de deprecación antes del lanzamiento.

Prueba estos prompts

Revisar fundamentos de REST

Usa el API Design Framework para proponer nombres de recursos, métodos, códigos de estado y formatos de error para una API sencilla de perfiles de clientes.

Redactar un esquema OpenAPI

Usa el API Design Framework para esquematizar un contrato OpenAPI 3.1 para una API de facturación con autenticación, paginación y errores de validación.

Comparar estilos de API

Usa el API Design Framework para comparar REST, GraphQL y gRPC para un servicio interno de búsqueda. Recomienda un enfoque con sus ventajas y desventajas.

Auditar una API lista para lanzamiento

Usa el API Design Framework para revisar esta propuesta de API en cuanto a versionado, autorización, idempotencia, observabilidad y riesgo de cambios incompatibles: [paste proposal].

Mejores prácticas

Empieza con los límites de recursos, los flujos de trabajo de los consumidores y la semántica de errores antes de elegir la sintaxis.
Usa versionado, periodos de deprecación y cambios aditivos para proteger a los clientes existentes.
Revisa las plantillas con responsables de backend, frontend, seguridad y plataforma antes del lanzamiento.

Evitar

No copies dominios, IDs o payloads de ejemplo en producción sin adaptarlos.
No expongas tablas de base de datos, nombres de métodos internos ni detalles de implementación en URLs.
No trates los esquemas de seguridad de las plantillas como controles finales de producción.