🛠️ Backend YKMiniURL

Bem-vindo ao backend do YKMiniURL! Este serviço foi desenvolvido para fornecer uma API confiável e robusta para gerenciar links curtos, protegê-los com senha e acompanhar estatísticas detalhadas.

---

🚀 Sobre o Projeto

O backend do YKMiniURL utiliza tecnologias modernas para garantir segurança e eficiência. Ele permite que os usuários:

• Encurtem URLs longas com facilidade.
• Protejam links com senhas personalizadas.
• Obtenham informações detalhadas sobre os links encurtados.
• Redirecionem links curtos para seus URLs originais com apenas um clique.

---

🖥️ Frontend

O frontend do YKMiniURL foi desenvolvido utilizando Next.js, TypeScript, TailwindCSS.

Acesse o frontend: YKMiniURL Frontend
Acesse o Repositorio: YKMINIURL Repositorio Frontend

✒ O UI/UX do YKMiniURL foi criado no Figma, utilizando Auto Layout.

Confira o design do projeto no Figma: Figma do YKMiniURL

🛠️ Tecnologias Utilizadas

Frontend

• Next.js
• TypeScript
• TailwindCSS

Backend

• Node.js
• Express.js
• MongoDB
• Bcrypt
• CORS
• Swagger

UI/UX

• figma
• photoshop

---

---

📚 Endpoints da API

🔗 Encurtar um Link

Method: POST
Endpoint: /shortlink

Exemplo de Requisição:

{
  "url": "https://exemplo.com",
  "password": "minhasenha"
}

Exemplo de resposta:

{
  "message": "link encurtado com sucesso",
  "shortUrl": "lkllz"
}

🔗 Renderecionar um Link

Method: GET
Endpoint: /getlink/{getshortlink}

Exemplo de Requisição:

Parameters: /getlink/{getshortlink}

Exemplo de resposta:

{
  "shortUrl": "lkllz",
  "url": null,
  "security": true
}

🔗 informações do link

Method: POST
Endpoint: /info

Exemplo de Requisição:

{
  "shortUrl": "string",
  "password": "string"
}

Exemplo de resposta:

{
  "originalUrl": "www.github.com",
  "shortUrl": "lkllz",
  "clicks": 0,
  "createdAt": "2024-12-22T17:02:36.387Z"
}

🔗 autorizar link com senha

Method: POST
Endpoint: /password

Exemplo de Requisição:

{
  "shortUrl": "string",
  "password": "string"
}

Exemplo de resposta:

{
  "shortUrl": "lkllz",
  "url": "www.github.com",
  "security": true
}

📚 Documentação da API

A YKMiniURL API é interativa e documentada via Swagger, permitindo que você explore endpoints, parâmetros e execute testes diretamente na interface.

🔗 Link da Documentação da API:

YKMiniURL API - Swagger

Como Começar

1. Consulte os endpoints disponíveis na documentação Swagger.
2. Teste a API usando ferramentas como Postman ou cURL.
3. Integre o serviço no seu sistema para otimizar o gerenciamento de links.

---

🎯 Funcionalidades da API

• Criar Links Curtos: Transforme URLs longas em links curtos.
• Adicionar Senhas: Defina uma senha para proteger o acesso aos links.
• Obter Informações: Acompanhe estatísticas detalhadas dos links criados.
• Redirecionar Links: Redirecione para URLs originais.

---

🐱‍👤 Funcionalidades futuras

• Reportar url
• Criar qrCode

🌟 Comece Agora - É Grátis!

Visite o site e aproveite todos os recursos:

🔗 YKMiniURL

---

📬 Contato

• Portfólio: Daniel Rocha
• GitHub: Dannick10
• E-mail: [email protected]

Sinta-se à vontade para abrir issues no repositório ou contribuir com melhorias!