{"id":17717227,"url":"https://github.com/devzgabriel/api-cepinspector","last_synced_at":"2026-05-07T01:04:50.080Z","repository":{"id":116141487,"uuid":"340678314","full_name":"devzgabriel/api-cepInspector","owner":"devzgabriel","description":"This is the CEP Inspector API repository. More information on how to access, install and test in the README","archived":false,"fork":false,"pushed_at":"2021-02-22T16:08:57.000Z","size":116,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-21T09:32:27.886Z","etag":null,"topics":["jest","jest-tests","knex","knexjs","migrations","node","nodejs","sqlite3","test","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devzgabriel.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-02-20T14:49:24.000Z","updated_at":"2021-02-22T16:08:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"3c6884ae-44b3-42a4-850e-cbabe4f0ce07","html_url":"https://github.com/devzgabriel/api-cepInspector","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/devzgabriel/api-cepInspector","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devzgabriel%2Fapi-cepInspector","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devzgabriel%2Fapi-cepInspector/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devzgabriel%2Fapi-cepInspector/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devzgabriel%2Fapi-cepInspector/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devzgabriel","download_url":"https://codeload.github.com/devzgabriel/api-cepInspector/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devzgabriel%2Fapi-cepInspector/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273105959,"owners_count":25046950,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-01T02:00:09.058Z","response_time":120,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jest","jest-tests","knex","knexjs","migrations","node","nodejs","sqlite3","test","typescript"],"created_at":"2024-10-25T14:19:17.743Z","updated_at":"2026-05-07T01:04:50.050Z","avatar_url":"https://github.com/devzgabriel.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CEP Inspector\n\n## Esse é o repositório da Api do CEP Inspector!\n\n\u003c!-- ### Você já pode testar o site se quiser! Só clicar nesse link: [CPF Inspector](sem-link) --\u003e\n\n### Se quiser visitar o repositório do frontend é só clicar nesse link: [CEP Inspector](https://github.com/devzgabriel/CEP-Inspector)\n\n\u003cbr\u003e\n\n## Rotas disponíveis\n\n**Inspecionar CEP**\n\n```HTTP\nURL estará disponível em breve!\n```\n\n### Enquanto não está disponivel pode usar um serviço alternativo ( [viaCep](https://viacep.com.br/) )\n\n```HTTP\nviacep.com.br/ws/{cep}/json/\n```\n\n\u003chr\u003e\n\n## **Como executar na sua máquina e testar**\n\n\u003cbr\u003e\n\n### **_Instalando e executando o projeto_**\n\nNo terminal digite todos os comandos abaixo:\n\n```Bash\ngit clone https://github.com/devzgabriel/api-cepInspector.git\n```\n\n```Bash\ncd api-cepInspector\n```\n\n```Bash\nyarn install\n```\n\n```Bash\nyarn knex-migrate\n```\n\n```Bash\nyarn dev\n```\n\n\u003chr\u003e\n\n### **Se seu objetivo é testar o frontend, isso é tudo que precisa faser! Mas se quer usar somente a API esses são os próximos passos:**\n\n\u003cbr\u003e\n\nPara fazer requisições use a url abaixo e insira o número do CEP (sem traços) no lugar de \"{cep}\"\n\n```HTTP\nhttp://localhost:3333/inspect/{cep}\n```\n\nO retorno será um JSON como exemplo abaixo:\n\n```JSON\n{\n  \"id\": 6,\n  \"cep\": \"01310924\",\n  \"logradouro\": \"Avenida Paulista 1912\",\n  \"complemento\": \"\",\n  \"bairro\": \"Bela Vista\",\n  \"localidade\": \"São Paulo\",\n  \"uf\": \"SP\",\n  \"ibge\": \"3550308\",\n  \"gia\": \"1004\",\n  \"ddd\": \"11\",\n  \"siafi\": \"7107\"\n}\n```\n\n### **_Executando testes_**\n\nOs testes serão acrescentados em breve!\n\n\u003c!--\nPara executar todos os testes digite o comando abaixo\n\n```Bash\nyarn test\n``` --\u003e\n\n\u003chr\u003e\n\n## **Criado por Gabriel Silva**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevzgabriel%2Fapi-cepinspector","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevzgabriel%2Fapi-cepinspector","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevzgabriel%2Fapi-cepinspector/lists"}