{"id":28226668,"url":"https://github.com/dsk-david/correioapi","last_synced_at":"2026-04-11T11:37:13.845Z","repository":{"id":227685525,"uuid":"767781506","full_name":"DsK-David/correioAPI","owner":"DsK-David","description":"O Correio API é um projeto pessoal criado com o objetivo de simular um sistema de gerenciamento de encomendas de um correio. ","archived":false,"fork":false,"pushed_at":"2024-06-04T13:53:19.000Z","size":6688,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-13T08:48:50.529Z","etag":null,"topics":["api","api-rest","correios","express","json","nodejs","sql","sqlite"],"latest_commit_sha":null,"homepage":"https://correioapi.onrender.com","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DsK-David.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-05T22:16:56.000Z","updated_at":"2025-01-31T10:52:39.000Z","dependencies_parsed_at":"2024-06-04T15:22:58.383Z","dependency_job_id":"deafc147-3ce3-492e-9d9f-9d17f866906f","html_url":"https://github.com/DsK-David/correioAPI","commit_stats":null,"previous_names":["dsk-david/correioapi"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/DsK-David/correioAPI","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DsK-David%2FcorreioAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DsK-David%2FcorreioAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DsK-David%2FcorreioAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DsK-David%2FcorreioAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DsK-David","download_url":"https://codeload.github.com/DsK-David/correioAPI/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DsK-David%2FcorreioAPI/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266625179,"owners_count":23958304,"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-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"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":["api","api-rest","correios","express","json","nodejs","sql","sqlite"],"created_at":"2025-05-18T12:09:15.862Z","updated_at":"2026-04-11T11:37:08.806Z","avatar_url":"https://github.com/DsK-David.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Correio API\n\nUma API simples para gerenciamento de encomendas de um correio.\n\n---\n\n## Sobre o Projeto\n\nO Correio API é um projeto pessoal criado com o objetivo de simular um sistema de gerenciamento de encomendas de um correio. Inspirado pela observação dos processos logísticos no dia a dia, decidi explorar conceitos de banco de dados SQL e desenvolvimento de APIs para criar uma solução básica e funcional.\n\n## Tecnologias Utilizadas\n\n- Node.js\n- Express.js\n- SQLite3\n\n## Pré-requisitos\n\nCertifique-se de ter o Node.js instalado em sua máquina.\n\n## Instalação\n\n1. Clone este repositório:\n\n```\ngit clone https://github.com/DsK-David/correioAPI.git\n```\n\n2. Instale as dependências:\n\n```\nnpm install\n```\n\n3. Inicie o servidor:\n\n```\nnpm start\n```\n\n## Contribuição\n\nSe você quiser contribuir com o projeto, siga as etapas abaixo:\n\n1. Faça um fork do repositório\n2. Crie uma branch para sua feature (`git checkout -b feature/NomeDaFeature`)\n3. Faça commit das suas mudanças (`git commit -am 'Adicionando uma nova feature'`)\n4. Faça push para a branch (`git push origin feature/NomeDaFeature`)\n5. Abra um Pull Request\n\n## Rotas\n\n### Listar todas as encomendas\n\n```\nGET /correioAPI/api/v1/encomendas\n```\n\nEsta rota retorna todas as encomendas cadastradas no sistema.\n\n### Criar uma nova encomenda\n\n```\nPOST /correioAPI/api/v1/encomendas\n```\n\nEsta rota é usada para criar uma nova encomenda. Os seguintes campos são obrigatórios no corpo da requisição:\n\n- `id`: ID único da encomenda (string)\n- `nome_proprietario`: Nome do proprietário da encomenda (string)\n- `contacto`: Contacto do proprietário da encomenda (integer)\n- `endereco`: Endereço de entrega da encomenda (string)\n- `documentos`: Documentos da encomenda (string)\n- `status`: Status da encomenda (string)\n\n### Atualizar o status de uma encomenda\n\n```\nPUT /correioAPI/api/v1/encomendas/:id\n```\n\nEsta rota é usada para atualizar o status de uma encomenda com base no ID fornecido na URL. O novo status deve ser passado no corpo da requisição.\n\n### Listar todas as encomendas com o status \"entregue\"\n\n```\nGET /correioAPI/api/v1/encomendas/entregues\n```\n\nEsta rota retorna todas as encomendas que têm o status \"entregue\".\n\n### Listar todas as encomendas com o status \"vindo\"\n\n```\nGET /correioAPI/api/v1/encomendas/vindo\n```\n\nEsta rota retorna todas as encomendas que têm o status \"vindo\".\n\n### Pesquisar encomendas por nome do proprietário\n\n```\nGET /correioAPI/api/v1/encomendas/:nome_proprietario\n```\n\nEsta rota retorna todas as encomendas cujo nome do proprietário corresponde ao fornecido na URL.\n\n### Buscar Encomenda por ID\n```\nGET /correioAPI/api/v1/encomendas/:id\n```\n\nEsta rota retorna os detalhes de uma encomenda específica com base no ID fornecido na URL.\n\n\n\n## Observações\n\n- Todas as respostas da API estão em formato JSON.\n- Certifique-se de fornecer os dados corretamente no corpo da requisição ao criar ou atualizar uma encomenda.\n- Os campos `id` das encomendas devem ser únicos. Ao criar uma nova encomenda, certifique-se de que o `id` fornecido ainda não foi usado.\n- Ao atualizar o status de uma encomenda, certifique-se de fornecer o ID correto na URL e o novo status no corpo da requisição.\n\nEste é um exemplo básico de uma API para gerenciamento de encomendas de um correio. Sinta-se à vontade para personalizá-la conforme suas necessidades. Se precisar de mais ajuda, não hesite em entrar em contato.\n\ncriado por DAVID SILVA\n\n- Instagram: [David Silva](https://www.instagram.com/n0_0ne__dsk)\n- Portfólio: [dsk-david.github.io](https://www.dsk-david.github.io)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsk-david%2Fcorreioapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdsk-david%2Fcorreioapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsk-david%2Fcorreioapi/lists"}