Redigir uma descrição de API a partir de rotas existentes
Modelo que transforma rotas e exemplos existentes em um rascunho OpenAPI com uma lista de pontos em aberto. Cole-o na ferramenta de IA que preferir, que então escreve o rascunho da descrição da API.
- Tipo
- Modelo
- Nível
- Intermediário
- Tempo
- cerca de 15 min
Os resultados dependem da ferramenta, do modelo e do que você digitar.
Prévia do resultado
Exemplo: escrito pela nossa redação, não é uma resposta real de IA.
paths: /orders/{id}: get: summary: Obter um pedido responses: "200": { $ref: "#/components/schemas/Order" } "404": { description: Pedido não encontrado } Pontos em aberto: - status: aqui "open", em /orders "pending" - Formato de erro de /refunds desconhecido
Preencher
O que você digita fica nesta janela do navegador. Não armazenamos nem enviamos nada.
- backend de loja com pedidos e produtos
- serviço interno de contas de usuário
- pequena API REST de um projeto pessoal
- API para parceiros e clientes
- endpoints de webhooks
- definições de rotas do código
- requisições e respostas de exemplo
- uma página antiga da wiki
- logs de chamadas reais sem dados pessoais
- uma mistura disso
- documentação para parceiros
- gerar um cliente
- verificações de contrato no build
- integração de novos desenvolvedores
- uma primeira visão geral
Seu prompt
Você editou o prompt. As mudanças nos campos acima não o substituem mais.
Isto é uma instrução para uma IA, ainda não o resultado.
Onde este prompt funciona
Estas ferramentas de IA combinam com este prompt:
Como usar
- Preencha os campos ou toque em uma sugestão. Deixe de fora nomes, endereços e outros dados pessoais.
- Copie o prompt pronto para a ferramenta de IA que preferir.
- Cole exemplos com valores inventados; tokens reais e dados de clientes não devem entrar no material.
Por que funciona?
Uma descrição escrita a partir do código mostra as lacunas que ninguém percebe enquanto o código funciona: erros não documentados, campos com dois significados e rotas que fogem do padrão.
Dicas
- Compare o rascunho com a API em funcionamento antes de publicá-lo; uma descrição diferente da realidade é pior do que nenhuma.