https://github.com/rsmuthu/urlshortener
Initiative to help College students to understand & learn FastAPI as part of a Workshop Also added a basic powerpoint on the same with this repo. And ofcourse, this is a very basic setup
https://github.com/rsmuthu/urlshortener
fastapi python3 sqlalchemy sqlite swagger
Last synced: about 2 months ago
JSON representation
Initiative to help College students to understand & learn FastAPI as part of a Workshop Also added a basic powerpoint on the same with this repo. And ofcourse, this is a very basic setup
- Host: GitHub
- URL: https://github.com/rsmuthu/urlshortener
- Owner: RSMuthu
- License: mit
- Created: 2022-06-07T17:59:17.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-06-07T18:30:14.000Z (about 4 years ago)
- Last Synced: 2025-09-12T22:12:07.270Z (10 months ago)
- Topics: fastapi, python3, sqlalchemy, sqlite, swagger
- Language: Python
- Homepage:
- Size: 1.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
This repo is an initiative to help College students to understand & learn FastAPI as part of a Workshop
Also added a basic powerpoint on the same with this repo.
And ofcourse, this is a very basic setup
# Lets Learn FastAPI by building URLShortener :)
This is a basic setup and sample URL Shortening backend web API
A simple application developed using FastAPI.
This is used for creating a short URLs and sharing across for easy usage.
This sharable short URL will be captive and act as Proxy
## Backend
- Python 3.10.4
- FastAPI
- Pydantic
- Sqlalchemy
- sqlite
(check the pipefile for detailed info on the required packages -- install them using `pipenv install` after `cd `)
##### API Endpoints
- `[GET] /api/urls`
- `[POST] /api/shorten`
- `[GET] /`
Swagger UI documentation will be available on running the application on
` [GET] /docs`
` [GET] /redoc`
` [GET] /openapi.json`
And to run the application,
`pipenv run uvicorn URLShortener:app`
##### Ways to Improve:
- Update the ORM modals and the definition of the Scheme with the additional data for improvised URL shortening system.
- Setup a UI/UX frontend for backend interaction.