Habilidades api-documentation
📝

api-documentation

Seguro

Generate API Documentation

También disponible en: CuriousLearner

This workflow helps developers create comprehensive API documentation by guiding them through OpenAPI specification creation, developer guide writing, code example generation, and interactive documentation setup.

Soporta: Claude Codex Code(CC)
🥉 72 Bronce
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-documentation". Use @api-documentation workflow to document my user management API

Resultado esperado:

I will guide you through creating comprehensive API documentation in 7 phases:

**Phase 1: API Discovery**
- Inventory your endpoints
- Document request/response formats
- Identify authentication requirements

[Guides through each phase with specific actions]

Usando "api-documentation". Create OpenAPI spec for my e-commerce API

Resultado esperado:

Here's your OpenAPI specification structure:

```yaml
openapi: 3.0.0
info:
title: E-Commerce API
version: 1.0.0
paths:
/products:
get:
summary: List products
responses:
200:
description: Successful response
```

Auditoría de seguridad

Seguro
v1 • 2/24/2026

Security analysis confirms this is a safe documentation workflow skill. The static analyzer flagged 28 instances of 'external_commands' (Ruby/shell backtick execution) and 9 instances of 'weak cryptographic algorithms', but both are false positives. The backticks in the file are Markdown code spans (e.g., `api-documenter`) used for skill name references, not shell command execution. No actual security risks were identified.

1
Archivos escaneados
165
Líneas analizadas
2
hallazgos
1
Auditorías totales
Problemas de riesgo medio (2)
SKILL.md:31SKILL.md:32SKILL.md:42-44SKILL.md:44-49SKILL.md:49-50SKILL.md:50-60SKILL.md:60-62SKILL.md:62-67SKILL.md:67-68SKILL.md:68-78SKILL.md:78-80SKILL.md:80-85SKILL.md:85-86SKILL.md:86-96SKILL.md:96-98SKILL.md:98-103SKILL.md:103-113SKILL.md:113-115SKILL.md:115-120SKILL.md:120-121SKILL.md:121-131SKILL.md:131-133SKILL.md:133-138SKILL.md:138-148SKILL.md:148-150SKILL.md:150-162SKILL.md:162-163SKILL.md:163-164
False Positive: Markdown Code Spans Flagged as Shell Commands
Static analyzer detected 'Ruby/shell backtick execution' at 28 locations, but these are Markdown inline code formatting (backticks around skill names like `api-documenter`), not shell command substitution. This is a false positive.
SKILL.md:3SKILL.md:15SKILL.md:22SKILL.md:32SKILL.md:38SKILL.md:125SKILL.md:132
False Positive: Cryptographic Algorithm Detection
Static analyzer flagged 9 instances of 'weak cryptographic algorithm', but this skill is a documentation workflow with no cryptographic operations. Likely triggered by pattern matching on the word 'api' or YAML content.
Auditado por: claude

Puntuación de calidad

38
Arquitectura
100
Mantenibilidad
87
Contenido
50
Comunidad
95
Seguridad
83
Cumplimiento de la especificación

Lo que puedes crear

New API Project Documentation

Create complete documentation for a new REST API from scratch, including OpenAPI spec, developer guide, and interactive docs.

Legacy API Documentation Update

Update and modernize existing API documentation to include OpenAPI specs, code examples, and interactive try-it features.

Internal API Portal Creation

Build an internal API portal with comprehensive documentation, code samples, and integration guides for internal teams.

Prueba estos prompts

Start API Documentation 
Use the @api-documentation workflow to create documentation for my REST API. I have an endpoint list and need help generating OpenAPI specs and a developer guide.
Generate OpenAPI Spec 
Use @api-documentation to create an OpenAPI specification for my API. The API has authentication via JWT and includes endpoints for users, products, and orders.
Add Code Examples 
Use the @api-documentation workflow to add code examples to my existing API documentation. I need examples in Python, JavaScript, and cURL.
Set Up Interactive Docs 
Use @api-documentation to set up interactive documentation with Swagger UI and Redoc for my existing OpenAPI spec. Configure try-it functionality.

Mejores prácticas

  • Start with API discovery to understand all endpoints before generating documentation
  • Keep OpenAPI specs in sync with actual API changes using automation
  • Test all code examples to ensure they work in production environments

Evitar

  • Skipping the discovery phase and jumping straight to documentation generation
  • Generating documentation without verifying accuracy of API specifications
  • Creating static docs that never get updated when APIs change

Preguntas frecuentes

What skills does this workflow invoke?
This workflow invokes skills like api-documenter, openapi-spec-generation, api-documentation-generator, docs-architect, and others to perform specific documentation tasks.
Do I need to install other skills?
Yes, some phases require other skills like api-documenter, openapi-spec-generation, and documentation-templates to be available in your skill library.
Can this workflow generate documentation for GraphQL APIs?
This workflow is optimized for REST APIs with OpenAPI specifications. GraphQL support would require adaptation or additional skills.
How do I keep my API documentation up to date?
Phase 7 covers automation setup with validation and monitoring. You can configure webhooks to trigger documentation rebuilds when APIs change.
What output formats does this workflow support?
The workflow produces OpenAPI (YAML/JSON), Markdown developer guides, code examples in multiple languages, and configures Swagger UI or Redoc for interactive docs.
Can I customize the documentation template?
Yes, you can modify the workflow phases and prompts to match your organization's documentation standards and branding requirements.

Detalles del desarrollador

Autor

sickn33

Licencia

MIT

Repositorio

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/api-documentation

Ref.

main

Estructura de archivos

📄 SKILL.md