Implementar com IA
Esta documentação também foi pensada para agentes de IA (Claude, ChatGPT, Cursor, Claude Code e outros). Dá para pedir que eles implementem a consulta de CEP no seu projeto já com o contexto certo.
Botões em cada página
Seção intitulada “Botões em cada página”No topo de cada página tem dois botões:
- Copiar Markdown copia o conteúdo da página em Markdown limpo, pronto para colar num chat.
- Abrir abre a página direto no Claude, no ChatGPT e em outros, já com um pedido para o agente ler a página e te ajudar.
Arquivos para agentes
Seção intitulada “Arquivos para agentes”| URL | O que tem |
|---|---|
/llms.txt |
Um índice da documentação, com um resumo do projeto e os links. |
/llms-full.txt |
Toda a documentação em português, num único arquivo de texto. |
/_llms-txt/english.txt |
A mesma documentação em inglês. |
/docs/<página>.md |
Qualquer página em Markdown: é só acrescentar .md à URL. |
Aponte o agente para o /llms-full.txt e ele terá todo o contexto de uma vez.
Prompts prontos
Seção intitulada “Prompts prontos”Escolha o seu ambiente, copie o prompt e cole no seu agente, ou abra direto no Claude ou no ChatGPT. Cada prompt traz um resumo da API e o link da documentação completa.
Implemente a consulta de CEP no meu projeto React usando a biblioteca unicep.
Documentação completa (leia primeiro): https://unicep.thet.dev/llms-full.txt
Resumo da API:
- npm install @unicep/react
- import { useCep } from '@unicep/react';
- const { data, error, isLoading } = useCep(value); // data is an Address; the lookup runs only for a valid CEP
- Options: useCep(value, { unicep, enabled })
- Erros (importe de @unicep/core): InvalidCepError, CepNotFoundError, AllProvidersFailedError.
O que eu preciso:
1. Um campo de CEP com máscara 00000-000 que busca o endereço sozinho quando o CEP estiver completo.
2. Preencha rua, bairro, cidade e UF com o resultado e mostre estados de carregamento e de erro.
3. Mostre mensagens diferentes para "CEP não encontrado" e "serviços indisponíveis".
4. Crie a instância do Unicep uma única vez (fora do componente), com cache ligado.
Siga as convenções do meu projeto e explique o que você alterou.Implemente a consulta de CEP no meu projeto Vue usando a biblioteca unicep.
Documentação completa (leia primeiro): https://unicep.thet.dev/llms-full.txt
Resumo da API:
- npm install @unicep/vue
- import { useCep } from '@unicep/vue';
- const { data, error, isLoading } = useCep(cepRef); // refs; the lookup runs only for a valid CEP
- Options: useCep(cepRef, { unicep, enabled })
- Erros (importe de @unicep/core): InvalidCepError, CepNotFoundError, AllProvidersFailedError.
O que eu preciso:
1. Um campo de CEP com máscara 00000-000 que busca o endereço sozinho quando o CEP estiver completo.
2. Preencha rua, bairro, cidade e UF com o resultado e mostre estados de carregamento e de erro.
3. Mostre mensagens diferentes para "CEP não encontrado" e "serviços indisponíveis".
4. Crie a instância do Unicep uma única vez, num módulo, com cache ligado.
Siga as convenções do meu projeto e explique o que você alterou.Implemente a consulta de CEP no meu projeto Angular usando a biblioteca unicep.
Documentação completa (leia primeiro): https://unicep.thet.dev/llms-full.txt
Resumo da API:
- npm install @unicep/angular
- import { injectCep, provideUnicep, UNICEP } from '@unicep/angular';
- readonly cep = injectCep(() => this.value()); // signals: cep.data(), cep.error(), cep.isLoading()
- Also: lookupCep(unicep, cep) returns an Observable; provideUnicep(new Unicep({...})) customizes the instance
- Erros (importe de @unicep/core): InvalidCepError, CepNotFoundError, AllProvidersFailedError.
O que eu preciso:
1. Um campo de CEP com máscara 00000-000 que busca o endereço sozinho quando o CEP estiver completo.
2. Preencha rua, bairro, cidade e UF com o resultado e mostre estados de carregamento e de erro.
3. Mostre mensagens diferentes para "CEP não encontrado" e "serviços indisponíveis".
4. Configure o Unicep uma única vez com provideUnicep, com cache ligado.
Siga as convenções do meu projeto e explique o que você alterou.Implemente a consulta de CEP no meu projeto Node.js usando a biblioteca unicep.
Documentação completa (leia primeiro): https://unicep.thet.dev/llms-full.txt
Resumo da API:
- npm install @unicep/core
- import { Unicep, defaultProviders } from '@unicep/core';
- const unicep = new Unicep({ providers: defaultProviders(), cache: {} }); // create once and reuse
- const address = await unicep.lookup(cep); // accepts 01310-100 or 01310100
- Erros (importe de @unicep/core): InvalidCepError, CepNotFoundError, AllProvidersFailedError.
O que eu preciso:
1. Um endpoint GET /cep/:cep que devolve o endereço em JSON.
2. Responda 400 para CEP inválido, 404 para "CEP não encontrado" e 503 quando todos os serviços falharem.
3. Crie a instância do Unicep uma única vez, com cache ligado, e cancele a consulta se o cliente desconectar.
Siga as convenções do meu projeto e explique o que você alterou.