api-documenter
Crear documentación de API precisa
Los equipos de API pierden tiempo cuando las especificaciones, los ejemplos y los portales se desvían del comportamiento real. Esta skill guía a Claude, Codex y Claude Code en la creación de documentación de API precisa y mantenible.
Instalar con mi Agente
Copia esta solicitud en tu Agente. Incluye la página canónica del Skill y el manifiesto.
Review the Skillstore skill "api-documenter" from https://skillstore.io/skills/sickn33-api-documenter.md and its manifest at https://skillstore.io/api/skills/sickn33-api-documenter/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.
Pruébalo
Usando "api-documenter". Una API REST tiene documentación de autenticación incompleta y notas de endpoints dispersas.
Resultado esperado:
Un plan de documentación que cubre flujos OAuth, orientación sobre actualización de tokens, grupos de endpoints, ejemplos de respuestas, manejo de errores y puntos de control de revisión.
Usando "api-documenter". Un equipo necesita una guía de migración para un cambio de versión de API con cambios incompatibles.
Resultado esperado:
Un esquema de migración con segmentos de audiencia, resúmenes de cambios incompatibles, pasos de actualización, notas de compatibilidad, orientación de pruebas y mensajes de despliegue.
Usando "api-documenter". Un portal para desarrolladores carece de incorporación y estructura de búsqueda.
Resultado esperado:
Un mapa del portal con flujo de inicio rápido, ruta de autenticación, secciones de SDK, páginas de resolución de problemas, ciclos de retroalimentación, necesidades de analítica y propiedad del mantenimiento.
Auditoría de seguridad
SeguroAll three static findings are false positives caused by ordinary documentation language. The skill contains guidance only, with no network reconnaissance instructions, executable code, or prompt injection.
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.
Copiar enlace del informe
https://skillstore.io/skills/sickn33-api-documenter/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportInsignia Markdown
[](https://skillstore.io/skills/sickn33-api-documenter?utm_source=security_passport_badge)Insignia HTML
<a href="https://skillstore.io/skills/sickn33-api-documenter?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/sickn33-api-documenter/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Tarjeta para insertar
<iframe src="https://skillstore.io/embed/skills/sickn33-api-documenter.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
sickn33. (2026). api-documenter security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-api-documenter/audits/5Cita BibTeX
@techreport{sickn33-sickn33-api-documenter-2026,
author = {sickn33},
title = {api-documenter security audit report (audit version 5)},
institution = {Skillstore},
year = {2026},
number = {5},
url = {https://skillstore.io/skills/sickn33-api-documenter/audits/5},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "api-documenter security audit report (audit version 5)"
version: "unspecified"
type: report
authors:
- name: "sickn33"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/sickn33-api-documenter/audits/5"
identifiers:
- type: other
value: "skillstore:sickn33-api-documenter:audit:5"
description: "Skillstore immutable audit report identifier"
Puntuación de Skillstore
Por qué esta puntuación Confianza de la evidencia: AltoLo que puedes crear
Escribir documentación de API lista para el lanzamiento
Crear guías de endpoints, explicaciones de autenticación, ejemplos y referencias de errores antes del lanzamiento de una nueva API.
Estandarizar especificaciones de API
Convertir notas de endpoints inconsistentes en especificaciones OpenAPI o AsyncAPI con esquemas y ejemplos.
Mejorar la incorporación de desarrolladores
Diseñar la estructura del portal, la documentación de SDK y las rutas de migración que ayudan a los desarrolladores a integrarse más rápido.
Prueba estos prompts
Usa api-documenter para escribir documentación clara para este endpoint. Incluye propósito, parámetros, autenticación, respuestas, errores y una solicitud de ejemplo.
Usa api-documenter para revisar esta superficie de API y proponer un plan de documentación OpenAPI 3.1. Identifica esquemas, ejemplos y flujos de autenticación faltantes.
Usa api-documenter para diseñar un portal para desarrolladores para estas APIs. Incluye navegación, ruta de incorporación, necesidades de búsqueda, documentación de SDK y flujo de mantenimiento.
Usa api-documenter para auditar este conjunto de documentación en cuanto a experiencia del desarrollador, precisión, versionado, pruebas y necesidades de migración. Prioriza las correcciones con justificación.
Mejores prácticas
- Proporciona el comportamiento real de la API, las reglas de autenticación y cargas útiles de ejemplo antes de pedir documentación final.
- Solicita pasos de validación para que las especificaciones, los fragmentos y las guías se mantengan alineados con la implementación.
- Revisa la documentación generada con las partes interesadas de producto, ingeniería, seguridad y soporte antes de publicarla.
Evitar
- No le pidas que invente el comportamiento de endpoints sin material fuente o suposiciones claras.
- No publiques orientación de seguridad generada sin revisión de responsables calificados.
- No trates la generación de documentación como reemplazo de las pruebas de contrato de API.