Habilidades api-doc-generator
📦

api-doc-generator

v1.0.0 Revisión del contenido r1 Seguro

Generar documentación de API

La documentación manual de API se queda atrás respecto al código y genera confusión para los desarrolladores. Esta skill ayuda a producir borradores de OpenAPI, ejemplos de solicitudes y orientación para colecciones de Postman a partir del código disponible o de los detalles de endpoints.

Compatible con: Claude Codex Code(CC)
🥈 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-doc-generator" from https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator.md and its manifest at https://skillstore.io/api/skills/zhangchenlai-dev-api-doc-generator/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/zhangchenlai-dev-api-doc-generator.md Manifest firmado GET /api/skills/zhangchenlai-dev-api-doc-generator/manifest Lockfile firmado GET /api/skills/zhangchenlai-dev-api-doc-generator/lockfile

Pruébalo

Usando "api-doc-generator". Un servicio de usuarios tiene endpoints para crear usuario, obtener usuario, actualizar usuario y eliminar usuario.

Resultado esperado:

Una referencia de API estructurada con resúmenes de endpoints, campos de solicitud, ejemplos de respuestas, códigos de estado y secciones listas para OpenAPI.

Usando "api-doc-generator". Un equipo tiene código de rutas pero no documentación de integración orientada a socios.

Resultado esperado:

Un borrador claro de integración que explica supuestos de autenticación, ejemplos de solicitudes, respuestas esperadas y organización de una colección de Postman.

Usando "api-doc-generator". Una especificación de API existente puede no incluir rutas añadidas recientemente.

Resultado esperado:

Una revisión de cobertura que enumera endpoints faltantes, esquemas incompletos, ejemplos poco claros y actualizaciones de documentación recomendadas.

Auditoría de seguridad

Seguro
v5 • 8/7/2026 Abrir el informe versionado

The only static finding was a high-entropy heuristic on SKILL.md. Manual review found plain Markdown skill metadata and usage notes, with no obfuscation, prompt injection, exfiltration intent, or dangerous actions.

1
Archivos escaneados
34
Líneas analizadas
0
Elementos de revisión
0
Falsos positivos ignorados
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
Evaluación de seguridad

Copiar enlace del informe

https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Insignia Markdown

[![Skillstore security assessment](https://skillstore.io/badges/skills/zhangchenlai-dev-api-doc-generator/security.svg)](https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator?utm_source=security_passport_badge)

Insignia HTML

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

Tarjeta para insertar

<iframe src="https://skillstore.io/embed/skills/zhangchenlai-dev-api-doc-generator.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

Hermes-Sedimentary. (2026). api-doc-generator security audit report (audit version 5) [Author version 1.0.0]. Skillstore. https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5

Cita BibTeX

@techreport{hermes-sedimentary-zhangchenlai-dev-api-doc-generator-2026, author = {Hermes-Sedimentary}, title = {api-doc-generator security audit report (audit version 5)}, institution = {Skillstore}, year = {2026}, number = {5}, url = {https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5}, 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-doc-generator security audit report (audit version 5)" version: "1.0.0" type: report authors: - name: "Hermes-Sedimentary" date-released: "2026-07-08" url: "https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5" identifiers: - type: other value: "skillstore:zhangchenlai-dev-api-doc-generator:audit:5" description: "Skillstore immutable audit report identifier"

Puntuación de Skillstore

Por qué esta puntuación Confianza de la evidencia: Medio
55
Arquitectura
100
Mantenibilidad
87
Contenido
67
Comunidad
83
Cumplimiento de la especificación

Lo que puedes crear

Documentar un servicio nuevo

Generar un primer borrador de contenido de referencia de API a partir de manejadores de rutas y notas de esquemas.

Preparar guías de integración

Convertir detalles de endpoints en ejemplos de solicitudes claros para socios externos.

Estandarizar especificaciones de API del equipo

Convertir notas dispersas de endpoints en una estructura coherente orientada a OpenAPI.

Prueba estos prompts

Crear documentación básica de endpoints 
Genera documentación de API para estos endpoints. Incluye método, ruta, propósito, parámetros, ejemplos de solicitudes y ejemplos de respuestas.
Crear un esquema de OpenAPI 
Revisa este código de API y crea un esquema de OpenAPI 3.0 con rutas, métodos, cuerpos de solicitud, esquemas de respuesta y errores comunes.
Preparar orientación para Postman 
Convierte esta documentación de endpoints en orientación para una colección de Postman. Incluye carpetas, nombres de solicitudes, encabezados, variables y cuerpos de ejemplo.
Auditar la cobertura de la documentación 
Compara estas rutas con la documentación actual de la API. Identifica endpoints faltantes, esquemas poco claros, ejemplos inconsistentes y descripciones de respuestas desactualizadas.

Mejores prácticas

  • Proporciona el código de rutas, las definiciones de esquemas y los detalles de autenticación juntos.
  • Solicita ejemplos que coincidan con las formas reales de solicitudes y respuestas.
  • Revisa el contenido generado de OpenAPI antes de compartirlo con clientes.

Evitar

  • No publiques especificaciones generadas sin validarlas contra la implementación.
  • No omitas el contexto de autenticación, manejo de errores o límites de tasa.
  • No trates los ejemplos con placeholders como detalles de contrato de producción.

Preguntas frecuentes

¿Puede esta skill crear un documento OpenAPI 3.0?
Sí. Puede redactar secciones de estilo OpenAPI a partir de código o descripciones de endpoints, pero un desarrollador debe validar el resultado.
¿Puede crear colecciones de Postman directamente?
Puede preparar orientación para colecciones de Postman y organización de solicitudes. La salida lista para importar puede necesitar formato manual.
¿Inspecciona una API en vivo?
No. La skill describe trabajo de documentación y no prueba endpoints en vivo por sí sola.
¿Qué entrada funciona mejor?
Funcionan mejor los manejadores de rutas, listas de métodos y rutas, definiciones de esquemas, payloads de muestra y notas de autenticación.
¿Es útil para equipos que no hablan inglés?
Sí. La descripción fuente está en chino y los usuarios pueden solicitar documentación en su idioma preferido.
¿La documentación generada es final?
No. La documentación generada debe revisarse para comprobar precisión, detalles de seguridad y comportamiento específico de la versión.

Detalles del desarrollador

Licencia

MIT

Versión del autor

v1.0.0

Revisión de Skillstore

r1

Repositorio

https://github.com/zhangchenlai-dev/hermes-skill-store/tree/master/api-doc-generator

Ref.

64ca8af0f54a325752f08bd54e52151061ea659a

Actualidad del mantenimiento

20/7/2026

Uso

2 descargas · 1 vistas

Estructura de archivos

📄 SKILL.md