Este fluxo de trabalho ajuda desenvolvedores a criar documentação abrangente de API, guiando-os através da criação de especificação OpenAPI, escrita de guia para desenvolvedores, geração de exemplos de código e configuração de documentação interativa.
تنزيل ZIP المهارة
رفع في Claude
اذهب إلى Settings → Capabilities → Skills → Upload skill
فعّل وابدأ الاستخدام
اختبرها
استخدام "api-documentation". Use o fluxo de trabalho @api-documentation para documentar minha API de gerenciamento de usuários
النتيجة المتوقعة:
Vou guiá-lo através da criação de documentação abrangente de API em 7 fases:
**Fase 1: Descoberta de API**
- Inventariar seus endpoints
- Documentar formatos de requisição e resposta
- Identificar requisitos de autenticação
[Guiando através de cada fase com ações específicas]
استخدام "api-documentation". Criar especificação OpenAPI para minha API de e-commerce
النتيجة المتوقعة:
Aqui está a estrutura da sua especificação OpenAPI:
```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
```
التدقيق الأمني
آمن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.
مشكلات متوسطة المخاطر (2)
درجة الجودة
ماذا يمكنك بناءه
Documentação de Novo Projeto de API
Criar documentação completa para uma nova API REST do zero, incluindo especificação OpenAPI, guia para desenvolvedores e documentos interativos.
Atualização de Documentação de API Legada
Atualizar e modernizar documentação de API existente para incluir especificações OpenAPI, exemplos de código e funcionalidades interativas de teste.
Criação de Portal Interno de API
Construir um portal interno de API com documentação abrangente, exemplos de código e guias de integração para equipes internas.
جرّب هذه الموجهات
Use o fluxo de trabalho @api-documentation para criar documentação para minha API REST. Tenho uma lista de endpoints e preciso de ajuda para gerar especificações OpenAPI e um guia para desenvolvedores.
Use @api-documentation para criar uma especificação OpenAPI para minha API. A API tem autenticação via JWT e inclui endpoints para usuários, produtos e pedidos.
Use o fluxo de trabalho @api-documentation para adicionar exemplos de código à minha documentação de API existente. Preciso de exemplos em Python, JavaScript e cURL.
Use @api-documentation para configurar documentação interativa com Swagger UI e Redoc para minha especificação OpenAPI existente. Configure a funcionalidade de teste.
أفضل الممارسات
- Comece com a descoberta de API para entender todos os endpoints antes de gerar documentação
- Mantenha as especificações OpenAPI sincronizadas com as mudanças reais da API usando automação
- Teste todos os exemplos de código para garantir que funcionam em ambientes de produção
تجنب
- Pular a fase de descoberta e pular direto para geração de documentação
- Gerar documentação sem verificar a precisão das especificações de API
- Criar documentos estáticos que nunca são atualizados quando as APIs mudam