Como documentar casos de uso práticos em api design em API Design

Prompt gerado automaticamente para Casos de uso práticos em API Design em API Design

5.0
34 usos
ChatGPT
Usar no ChatGPT
"Você é um especialista em API Design. Crie um guia prático e acionável para um time de desenvolvimento de software que está iniciando a criação de uma API RESTful para um sistema de gestão de estoque. O guia deve focar em como identificar e documentar os **casos de uso mais críticos e frequentes** para essa API, garantindo que o design atenda às necessidades reais dos usuários (operadores de estoque, gerentes, sistemas externos). Inclua exemplos concretos de como traduzir interações do mundo real (ex: 'registrar entrada de mercadoria', 'consultar nível de estoque de um item') em endpoints e payloads bem definidos, destacando as decisões de design para otimização de performance e usabilidade. O guia deve ser estruturado em passos, desde a coleta de requisitos até a prototipagem inicial da documentação OpenAPI."

Como Usar este Prompt

1

Clique no botão "Copiar Prompt" para copiar o conteúdo completo.

2

Abra sua ferramenta de IA de preferência (ChatGPT e etc.).

3

Cole o prompt e substitua as variáveis (se houver) com suas informações.

Compartilhe

Gostou deste prompt? Ajude outras pessoas a encontrá-lo!

Outros prompts de API Design

Continue explorando prompts nesta categoria.

Guia para troubleshooting em api design em API Design

Prompt gerado automaticamente para Troubleshooting em API Design em API Design

Guia para testing em api design em API Design

Prompt gerado automaticamente para Testing em API Design em API Design

Guia para testing em api design em API Design

Prompt gerado automaticamente para Testing em API Design em API Design