🔌
ChatGPT intermediate

Dicas de documentação em api design para API Design

Prompt gerado automaticamente para Documentação em API Design em API Design

2 usos API Design

Prompt completo

"Você é um especialista em design de API com foco em documentação para desenvolvedores. Sua tarefa é criar um modelo de prompt altamente eficaz para um gerente de produto que precisa gerar automaticamente um rascunho inicial de documentação de 'Getting Started' (Primeiros Passos) para uma nova API RESTful. O objetivo é que este rascunho seja compreensível para um desenvolvedor júnior e contenha todos os elementos cruciais para que ele possa fazer sua primeira chamada bem-sucedida à API em menos de 15 minutos, mesmo sem conhecimento prévio da mesma.

O prompt que você criará deve ser genérico o suficiente para ser adaptado a diferentes APIs, mas específico o bastante para direcionar o modelo de IA a produzir conteúdo de alta qualidade e relevância. Ele deve solicitar os dados essenciais da API (como nome, propósito principal, endpoint base, métodos HTTP comuns e exemplos de corpo de requisição/resposta) de forma estruturada e clara, e então instruir o modelo a formatar a saída de maneira didática, incluindo seções como:

1.  **Visão Geral Rápida:** O que a API faz e para quem ela é.
2.  **Autenticação:** Como obter e usar uma chave de API (exemplo: token Bearer).
3.  **Primeira Requisição:** Um exemplo completo e copiável de uma requisição `GET` simples (ex: `GET /items`) usando `curl` e um exemplo de resposta JSON esperada.
4.  **Próximos Passos:** Sugestões para explorar outros endpoints ou recursos.

A saída do modelo de IA deve ser em Markdown, pronta para ser copiada para um repositório Git ou ferramenta de documentação.

**Seu prompt deve ser:**
*   Claro e conciso.
*   Direcionado a obter um resultado prático e utilizável.
*   Focado na experiência do desenvolvedor (DX).
*   Estruturado para guiar a IA a pedir as informações necessárias e a formatar a saída corretamente.

**Exemplo de como o prompt poderia ser iniciado (não é a resposta final, apenas uma inspiração):**
'Gere um rascunho de documentação 'Getting Started' para uma nova API RESTful. Para isso, preciso que você me solicite as seguintes informações...'

Tags relacionadas

API Design Documentação em API Design gerado-automaticamente

Como usar este prompt

1

Clique no botão "Copiar" para copiar o prompt para sua área de transferência

2

Acesse sua ferramenta de IA preferida (ChatGPT, ChatGPT, Claude, etc.)

3

Cole o prompt e adapte conforme necessário para seu contexto específico