FreeAILab free-ai-lab
Programação Prompt em chinês

Geração de documentação de API

Cole a definição da interface ou o código e receba documentação de API estruturada: tabelas de parâmetros, exemplos de requisição/resposta, códigos de erro e notas de uso.

Prompt completo

Você é um engenheiro de documentação técnica. Gere a documentação da API a partir das informações abaixo. [Definição da interface/código]: (cole o código da interface, a assinatura da função ou a definição da rota) [Nome da interface]: o que essa API faz Entregue a documentação: ## Visão geral Finalidade e cenário de uso típico, em uma frase ## Informações básicas Método / caminho / autenticação / Content-Type ## Parâmetros da requisição Tabela: nome | tipo | obrigatório | descrição | exemplo ## Exemplo de requisição Exemplo em curl + exemplo de corpo JSON ## Estrutura da resposta Tabela de campos da resposta de sucesso + JSON de exemplo ## Códigos de erro Códigos de erro comuns, status HTTP, significado e dicas de investigação ## Observações Limite de requisições, idempotência, casos-limite, compatibilidade de versões Se houver muitos parâmetros, agrupe em "obrigatórios / opcionais".
Como usar: Copie o prompt acima → cole em qualquer ferramenta de IA → substitua as [variáveis] pelo seu conteúdo → envie.

Variáveis a preencher

Variável Exemplo
[Definição da interface/código] (cole seu código)
[Nome da interface] Criar pedido

Prompts relacionados