https://github.com/fantaso/url-shortener-api
Url shortener API with Django and django rest framework. Project consists to allow a user to transform a long web url into a pattern-consistent (encoded) small url easy to share and remember.
https://github.com/fantaso/url-shortener-api
django django-rest-framework postman python3 sqlite3
Last synced: 2 months ago
JSON representation
Url shortener API with Django and django rest framework. Project consists to allow a user to transform a long web url into a pattern-consistent (encoded) small url easy to share and remember.
- Host: GitHub
- URL: https://github.com/fantaso/url-shortener-api
- Owner: Fantaso
- Created: 2019-11-21T04:08:56.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-11-25T18:17:10.000Z (over 6 years ago)
- Last Synced: 2025-03-21T19:45:25.717Z (over 1 year ago)
- Topics: django, django-rest-framework, postman, python3, sqlite3
- Language: Python
- Homepage: https://github.com/Fantaso/url-shortener-api
- Size: 37.1 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Url Shortener API
> Url shortener API with Django and django rest framework.
Project consists to allow a user to transform a long web url into a
pattern-consistent (encoded) small url easy to share and remember.
At the same time the user is allowed to transform back (decode)
the small url into the original url
It is partly tested as only and was developed as showcase only.
How Url Shortener API Works:
- You can send (POST) a full url and retrieve a small encoded one with tier.app as the base web service url.
Eg. POST http://localhost:8000/shorten-url
with https://python.org/long-url
result: https://tier.app/sY6f3J (6 digits id)
- You can get the original url with the encoded url on a GET request (done in previous step)
Eg. GET https://tier.app/sY6f3J
result: https://python.org/long-url
## Index:
- #### Installation
1. Installing Django API App
- #### Usage:
1. Available Endpoints
2. Tests INFO & GUI testing
- #### What's Next:
1. thoughts on improving it.
- Testing
- API
- Database
- DevOps
- #### Information:
- #### Maintainer
## Installation:
#### 1.Installing Django API App
1. Clone repository and go inside the repository folder "url-shortener-api"
```sh
git clone https://github.com/Fantaso/url-shortener-api.git
```
2. Create you virtualenv and install the packages
```sh
pip install -r requirements.txt
```
3. Initialize database and create the database mapping used for persistance in the url shortener API.
```sh
python manage.py makemigrations
```
4. Apply the database mapping from the app to the database; migrate the database.
```sh
python manage.py migrate
```
5. Run the application.
```sh
python manage.py runserver
```
## USAGE
#### 1. Endpoint List
URI Example: `http://localhost:8000/shorten-url/`
| | Available Methods | URI | Example URL |
| -: | :- | :- | -: |
| | | | |
| | **Project Endpoints** | | |
| 1. | `POST` | `shorten-url/` | `http://localhost:8000/shorten-url` |
| 2. | `GET` | `/` | `http://localhost:8000/` |
#### 2. Tests INFO
1. Run the Url Shortener API app tests locally with:
```sh
python manage.py test
```
###### Access and Interact with a GUI app (Postman)
To interact and start using the API, you will need a tool send HTTP requests to your api. I have develop a list of request to test and interact with the api with Postman. You will need to download the Postman Desktop app or the Web Browser plug in for Chrome. Click on the button below to guide you to download the app with the list of request I have developed to test the api fast.
[![Run in Postman][postman-button-svg]][postman-button-link]
## WHATS NEXT
#### 1. Thoughts on improving it.
###### Testing
- integrate functional testing into the django app
- finish testing and refactor repetitive code
- set up test coverage for reporting
- set up linting flake8 to check for styling and consistency
- add personalized assert messages and setup error message separated structure
###### API
- set up error handling and eliminate chunks of ugly try:
- set up rest full service (if required (del, list, ...))
- do short url should expire set up?
- refactor
###### Database
- set up a second db for stats
- set up and split stats and ShortUrl models
###### DevOps
- set up automated testing pipeline
## Information:
| Technology Stack | | |
| :- | :-: | :- |
| Python | ![back-end][python] | Back-End |
| Django | ![django][django] | Web Framework |
| Django Rest Extension | ![api-extension][django-rest-extension]| API Django Extension |
| SQLite | ![database][sqlite] | Database |
| Postman | ![http request app][postman] | HTTP requests app |
## Maintainer
Get in touch -–> [Github][github-profile]
[github-profile]: https://github.com/fantaso/
[linkedin-profile]: https://www.linkedin.com/
[fantaso]: https://www.fantaso.de/
[postman-button-svg]:https://run.pstmn.io/button.svg
[postman-button-link]:https://app.getpostman.com/run-collection/62ef5e078ec400e93201
[github-repo]: https://github.com/Fantaso/url-shortener-api
[travis-link]: https://travis-ci.org/
[travis-image]: https://travis-ci.org/
[python]: readme/python.png
[django]: readme/django.png
[django-rest-extension]: readme/django-rest-extension.png
[sqlite]: readme/sqlite.jpeg
[postman]: readme/postman.png