Como melhorar ferramentas para api design em API Design

Prompt gerado automaticamente para Ferramentas para API Design em API Design

5.0
35 usos
ChatGPT
Usar no ChatGPT
"Você é um especialista em API Design. Crie um prompt para um gerador de código que, a partir de um esquema OpenAPI (versão 3.1.0) complexo, consiga gerar não apenas os *stubs* de código para o cliente e servidor (em Python, usando FastAPI e httpx), mas também:

1. **Documentação interativa e navegável (HTML)** que detalhe cada *endpoint*, seus parâmetros (com exemplos válidos baseados nos tipos do esquema), modelos de requisição e resposta (com exemplos JSON formatados), e status codes esperados, de forma mais amigável e explicativa que o Swagger UI padrão, talvez com seções de "Como usar" e "Melhores práticas".
2. **Casos de teste automatizados (em Pytest)** para cada *endpoint* que cubram cenários de sucesso (com dados de requisição válidos gerados a partir do esquema) e cenários de erro (validação de tipos, campos obrigatórios ausentes, etc.), utilizando os *stubs* gerados para o cliente para interagir com o servidor.
3. **Mocks de dados realistas (em JSON ou Python)** para cada modelo de resposta definido no esquema, que possam ser usados para simular o comportamento da API em ambientes de desenvolvimento ou para testes unitários, incluindo variações para diferentes estados ou dados.

O objetivo é que o desenvolvedor tenha uma 'caixa de ferramentas' completa e funcional a partir de um único esquema, acelerando significativamente o desenvolvimento, teste e documentação de APIs."

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