LinkSnap is a URL shortening service built using Go, Gin, and MongoDB. It allows users to create short URLs, view their details, track analytics, and generate QR codes for easy sharing.
- Create short URLs with optional custom aliases
- List all short URLs
- Retrieve detailed information about a specific URL
- Delete short URLs
- View analytics and usage statistics
- Generate QR codes for short URLs
| Endpoint | Method | Description |
|---|---|---|
/api/urls |
POST | Create a short URL |
/api/urls |
GET | List all URLs |
/api/urls/:code |
GET | Get URL details by short code |
/api/urls/:code |
DELETE | Delete a short URL |
| Endpoint | Method | Description |
|---|---|---|
/api/urls/:code/stats |
GET | Get URL analytics and statistics |
/api/urls/:code/qr |
GET | Generate a QR code for a short URL |
| Error Code | Message | Description |
|---|---|---|
| 400 | Invalid Request |
The request payload is malformed or incomplete |
| 404 | URL not found |
The specified short code does not exist in the system |
| 409 | Custom Alias Already Exists |
The requested custom alias is already in use |
| 500 | Internal Server Error |
An unexpected error occurred on the server |
- Max Requests per User: 100 requests per hour
- Rate Limiting: Excessive requests will return a
429 Too Many Requestserror.
- Install Go (version 1.18 or higher).
- Install MongoDB.
- Install Postman for testing API endpoints (optional).
- Clone the repository:
git clone https://github.com/your-username/linksnap.git cd linksnap - Set up environment variables:
Create a
.envfile in the project root with the following variables:DB_URI=mongodb://localhost:27017 COLLECTION_NAME=linksnap PORT=8080 - Install dependencies:
go mod tidy - Start the server:
go run main.go - Test the API endpoints using Postman.
API documentation is published on here with example requests and responses
This project is licensed under the MIT License. Feel free to contribute or suggest improvements! 🚀