https://github.com/eedu7/url-shortening-service
https://github.com/eedu7/url-shortening-service
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/eedu7/url-shortening-service
- Owner: eedu7
- Created: 2024-09-13T03:09:11.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-15T04:12:31.000Z (9 months ago)
- Last Synced: 2025-02-01T23:45:21.484Z (4 months ago)
- Language: Python
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# URL Shortening Service
Sample solution for the [url-shortening-service](https://roadmap.sh/projects/url-shortening-service) challenge from [roadmap.sh](https://roadmap.sh/).
## How to run
```bash
$ git clone https://github.com/eedu7/url-shortening-service.git
$ cd url-shortening-service
$ pip install -r requirements.txt
$ python main.py
```
# API Endpoints
Given below are the details for each API operation.
## Create Short URL
Create a new short URL using the POST method
> POST /shorten
```json
{
"url": "https://www.example.com/some/long/url"
}
```
The endpoint should validate the request body and return a 201 Created status code with the newly created short URL i.e.
```json
{
"id": "1",
"url": "https://www.example.com/some/long/url",
"shortCode": "abc123",
"createdAt": "2021-09-01T12:00:00Z",
"updatedAt": "2021-09-01T12:00:00Z"
}
```
or a 400 Bad Request status code with error messages in case of validation errors. Short codes must be unique and should be generated randomly.
## Retrieve Original URL
Retrieve the original URL from a short URL using the GET method
> GET /shorten/abc123
The endpoint should return a 200 OK status code with the original URL i.e.
```json
{
"id": "1",
"url": "https://www.example.com/some/long/url",
"shortCode": "abc123",
"createdAt": "2021-09-01T12:00:00Z",
"updatedAt": "2021-09-01T12:00:00Z"
}
```
or a 404 Not Found status code if the short URL was not found. Your frontend should be responsible for retrieving the original URL using the short URL and redirecting the user to the original URL.
## Update Short URL
Update an existing short URL using the PUT method
> PUT /shorten/abc123
```json
{
"url": "https://www.example.com/some/updated/url"
}
```
The endpoint should validate the request body and return a 200 OK status code with the updated short URL i.e.
```json
{
"id": "1",
"url": "https://www.example.com/some/updated/url",
"shortCode": "abc123",
"createdAt": "2021-09-01T12:00:00Z",
"updatedAt": "2021-09-01T12:30:00Z"
}
```
or a 400 Bad Request status code with error messages in case of validation errors. It should return a 404 Not Found status code if the short URL was not found.
## Delete Short URL
Delete an existing short URL using the DELETE method
> DELETE /shorten/abc123
The endpoint should return a 204 No Content status code if the short URL was successfully deleted or a 404 Not Found status code if the short URL was not found.
## Get URL Statistics
Get statistics for a short URL using the GET method
> GET /shorten/abc123/stats
The endpoint should return a 200 OK status code with the statistics i.e.
```json
{
"id": "1",
"url": "https://www.example.com/some/long/url",
"shortCode": "abc123",
"createdAt": "2021-09-01T12:00:00Z",
"updatedAt": "2021-09-01T12:00:00Z",
"accessCount": 10
}
```
or a 404 Not Found status code if the short URL was not found.