# doc-api

> Gerar documentação de API abrangente a partir do código com exemplos interativos e capacidades de teste

- Fonte: https://doutorai.pt/componentes/commands__doc-api
- Tipo: Comandos
- Categoria: Documentation
- Downloads: 317
- Site: Doutor AI (https://doutorai.pt) - ferramentas de IA para pequenos negócios em português

Componente da comunidade open-source, selecionado, traduzido e adaptado pelo Doutor AI.

## Para que serve e como usar

Um **comando /slash** pronto a usar que executa um fluxo de trabalho de documentation num só passo.

1. Instale o comando (comando acima).
2. No Claude Code escreva "/" seguido do nome do comando.
3. Siga as instruções que o comando pede e deixe-o correr.

## Instalar (Claude Code)

```bash
mkdir -p .claude/commands && curl -fsSL https://doutorai.pt/data/lib/commands__doc-api.md -o .claude/commands/doc-api.md
```

Cole este comando no terminal, na pasta do seu projeto, e o componente é instalado automaticamente.

## Conteúdo

```
---
allowed-tools: Read, Write, Edit, Bash
argument-hint: [api-type] | --openapi | --graphql | --rest | --grpc | --interactive
description: Generate comprehensive API documentation from code with interactive examples and testing capabilities
---

# API Documentation Generator

Generate API documentation from code: $ARGUMENTS

## Current API Context

- API endpoints: !`find . -name "*route*" -o -name "*controller*" -o -name "*api*" | head -5`
- API specs: !`find . -name "*openapi*" -o -name "*swagger*" -o -name "*.graphql" | head -3`
- Server framework: @package.json or detect from imports
- Ex

- 🔒 Conteúdo completo no plano Pro (7,99€/mês) -
```

## Componentes relacionados

- [act](https://doutorai.pt/componentes/commands__act): Executar GitHub Actions localmente usando o act
- [add-authentication-system](https://doutorai.pt/componentes/commands__add-authentication-system): Implementar um sistema seguro de autenticação de utilizadores com o método escolhido e as melhores práticas de segurança
- [add-changelog](https://doutorai.pt/componentes/commands__add-changelog): Gerar e manter o changelog do projeto com o formato Keep a Changelog
- [add-mutation-testing](https://doutorai.pt/componentes/commands__add-mutation-testing): Configurar testes de mutação abrangentes com seleção de framework e integração CI
- [add-package](https://doutorai.pt/componentes/commands__add-package): Adicionar e configurar um novo pacote ao workspace com a estrutura e dependências adequadas
- [add-performance-monitoring](https://doutorai.pt/componentes/commands__add-performance-monitoring): Configurar monitorização abrangente de desempenho de aplicações com métricas, alertas e observabilidade

## Poupe horas todas as semanas com IA, sem complicações

O **Doutor AI** dá-lhe 1859 prompts de IA prontos a copiar, por indústria e em português simples - mais uma biblioteca técnica completa para quem quer ir mais longe. [Ver planos →](https://doutorai.pt/precos)

---
Conteúdo de Doutor AI (https://doutorai.pt). Ao citar, indique a fonte: https://doutorai.pt/componentes/commands__doc-api