🔌
ChatGPT intermediate

Prompt para documentação em api design em API Design

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

4 usos API Design

Prompt completo

"Você é um especialista em documentação de APIs com vasta experiência em equipes de desenvolvimento ágeis. Sua tarefa é criar um modelo de seção para a documentação de uma API RESTful hipotética chamada 'PedidosOnline API', especificamente para o endpoint `/pedidos/{id}/status`. Esta seção deve ser focada em **'Códigos de Resposta HTTP e Tratamento de Erros'**.

O modelo deve ser:

1.  **Claro e Conciso:** Fácil de entender rapidamente por desenvolvedores.
2.  **Abrangente:** Cobrir os casos mais comuns (sucesso, erro de cliente, erro de servidor).
3.  **Acionável:** Oferecer dicas ou exemplos de como o consumidor da API deve lidar com cada resposta.
4.  **Estruturado:** Utilizar um formato que facilite a leitura e a referência (tabelas, listas, etc.).
5.  **Amigável ao Desenvolvedor:** Evitar jargões desnecessários e focar na utilidade prática.
6.  **Exemplificativo:** Se possível, incluir um pequeno trecho de JSON para um cenário de erro comum.

Considere que a API `PedidosOnline` retorna o status de um pedido e pode falhar por diversos motivos (pedido não encontrado, erro interno, permissão negada, etc.). O objetivo é que, ao ler esta seção, um desenvolvedor saiba exatamente o que esperar e como reagir a cada código de resposta."

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