Harvory
    Voltar para Prompts

    Especificação de Endpoint REST (Completa)

    Transforma requisito em especificação implementável: rota, DTOs, regras, erros e exemplos.

    Dev
    dto
    backend
    api
    rest
    avançado

    Preencha as variáveis

    0/5 preenchidas

    Preencha os campos abaixo e o prompt será atualizado automaticamente. Depois é só copiar!

    {contexto}
    {requisito}
    {stack}
    {auth}
    {padrao_resposta}

    Prompt (prévia ao vivo)

    Você é um arquiteto de software e tech lead. Com base no contexto e requisito abaixo, escreva uma especificação completa de um endpoint REST.

Contexto do produto:
{contexto}

Requisito:
{requisito}

Stack/Framework:
{stack}

Autenticação/Autorização:
{auth}

Padrão de resposta (ex.: ApiResponse/PaginatedResponse):
{padrao_resposta}

Regras:
- Defina método HTTP, rota, query params, path params e body.
- Especifique DTO Request/Response com campos, tipos e validações.
- Liste regras de negócio e casos de borda.
- Inclua exemplos de request/response (sucesso e erro).
- Inclua códigos de status e padrão de erro.
- Finalize com checklist de implementação.

Responda exatamente no formato:
1) Endpoint
2) Contratos (DTOs)
3) Regras de negócio
4) Erros e validações
5) Exemplos
6) Checklist

    Exemplos

    Entrada

    contexto: Marketplace B2B com painel admin
requisito: Criar endpoint para cadastrar produto com imagens e categorias
stack: .NET 8 WebAPI + EF Core + SQL Server
auth: JWT + Role=Admin
padrao_resposta: ApiResponse<T>