https://github.com/khaledalam/cruid_api
CRUID Python FastAPI Alembic.
https://github.com/khaledalam/cruid_api
alembic docker docker-compose fastapi python rest-api
Last synced: 3 months ago
JSON representation
CRUID Python FastAPI Alembic.
- Host: GitHub
- URL: https://github.com/khaledalam/cruid_api
- Owner: khaledalam
- Created: 2023-03-18T12:55:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-18T13:02:10.000Z (over 3 years ago)
- Last Synced: 2025-04-04T23:11:24.240Z (about 1 year ago)
- Topics: alembic, docker, docker-compose, fastapi, python, rest-api
- Language: Python
- Homepage:
- Size: 1.15 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# For coding assignment purpose.
## Simple CRUD APIs
#### No middlewares, security, logging, validations(except email) handled.
### Requirements
- Docker and docker-compose `apt install docker.io docker-compose`
- Make sure 8888 and 3306 ports are not in use.
### Run
1. Env & run containers: `./setup.sh`
2. Migration: `docker exec -it api alembic upgrade head`
Ping to validate setup is done correctly:
```curl
curl -X 'GET' 'http://0.0.0.0:8888/' -H 'accept: application/json'
```
### URLs
- Documentation: http://0.0.0.0:8888/documentation
- Re-Documentation: http://0.0.0.0:8888/re-documentation
- Openapi.json: http://0.0.0.0:8888/openapi.json
### Demo
Containers
Docs
Structure
#### Postman APIs:
1. Get all
2. Get one
3. Create new
4. Update one
5. Delete one
