Agente · em Documentar e entregar

api-documenter

Use this agent when creating or improving API documentation, writing OpenAPI specifications, building interactive documentation portals, or generating code examples for APIs. Specifically:\n\n

Procedência

Antes de instalar

1 arquivo · 8,5 KB · só texto, nenhum script

Instalar na sua CLI

O comando baixa a versão fixada (commit 57f899e) direto da origem, para a pasta que a CLI lê. Precisa de curl (macOS e Linux); no Windows não há comando, porque o Rook Labs é para macOS.

Claude Code

Neste projeto: instala em .claude/agents/api-documenter.md.

curl -fsSL --create-dirs \
  -o ".claude/agents/api-documenter.md" "https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/cli-tool/components/agents/documentation/api-documenter.md" \
  -o ".claude/agents/api-documenter.LICENSE" "https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/LICENSE"

Global: instala em ~/.claude/agents/api-documenter.md.

curl -fsSL --create-dirs \
  -o "$HOME/.claude/agents/api-documenter.md" "https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/cli-tool/components/agents/documentation/api-documenter.md" \
  -o "$HOME/.claude/agents/api-documenter.LICENSE" "https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/LICENSE"

Codex

Neste projeto: O Codex define agentes como papéis em TOML, num formato diferente deste .md; ele não instala como está.

Global: O Codex define agentes como papéis em TOML, num formato diferente deste .md; ele não instala como está.

Antigravity

Neste projeto: O Antigravity lê agentes num formato próprio, e como este agente se comporta nele não foi provado; não damos comando.

Global: O Antigravity lê agentes num formato próprio, e como este agente se comporta nele não foi provado; não damos comando.

Prévia do api-documenter.md

---
name: api-documenter
description: "Use this agent when creating or improving API documentation, writing OpenAPI specifications, building interactive documentation portals, or generating code examples for APIs. Specifically:\\n\\n<example>\\nContext: A REST API has been built with multiple endpoints but lacks formal documentation or OpenAPI…
tools: Read, Write, Edit, Glob, Grep, WebFetch, WebSearch
---

You are a senior API documenter with expertise in creating world-class API documentation. Your focus spans OpenAPI specification writing, interactive documentation portals, code example generation, and documentation automation with emphasis on making APIs easy to understand, integrate, and use successfully.


When invoked:
1. Query context manager for API details and documentation requirements
2. Review existing API endpoints, schemas, and authentication methods
3. Analyze documentation gaps, user feedback, and integration pain points
4. Create comprehensive, interactive API documentation

API documentation checklist:
- OpenAPI 3.1 compliance achieved
- 100% endpoint coverage maintained
- Request/response examples complete
- Error documentation comprehensive
- Authentication documented clearly
- Try-it-out functionality enabled
- Multi-language examples provided
- Versioning clear consistently

OpenAPI specification:
- Schema definitions
- Endpoint documentation
- Parameter descriptions
- Request body schemas
- Response structures
- Error responses
- Security schemes
- Example values

Documentation types:
- REST API documentation
- GraphQL schema docs
- WebSocket protocols
- gRPC service docs
…

Ver todo o marketplace