Robust web API powered by Falcon, SQLAlchemy and Docker
- Falcon
- SQLAlchemy (declarative base)
- Alembic
- Docker
TODO
.
├── Dockerfile
├── Makefile
├── Pipfile
├── Pipfile.lock
├── README.md
├── core
│ ├── __init__.py
│ ├── api
│ │ ├── __init__.py
│ │ ├── book
│ │ │ ├── __init__.py
│ │ │ ├── backend.py
│ │ │ ├── domain.py
│ │ │ ├── models.py
│ │ │ └── resource.py
│ │ ├── common
│ │ │ ├── __init__.py
│ │ │ ├── database.py
│ │ │ ├── exceptions.py
│ │ │ ├── middleware
│ │ │ │ ├── __init__.py
│ │ │ │ ├── context.py
│ │ │ │ ├── request.py
│ │ │ │ └── response.py
│ │ │ ├── serializers.py
│ │ │ └── utils.py
│ │ └── schemas
│ │ ├── __init__.py
│ │ └── book
│ │ ├── __init__.py
│ │ ├── create_book.json
│ │ └── update_book.json
│ ├── migrations
│ │ ├── __init__.py
│ │ ├── alembic.ini
│ │ ├── env.py
│ │ ├── script.py.mako
│ │ └── versions
│ │ ├── 8d0c7114a367_init_book_api.py
│ │ └── __init__.py
│ ├── routes.py
│ └── wsgi.py
├── deployment
│ ├── nginx
│ │ ├── Dockerfile
│ │ └── sites-enabled
│ │ └── banaspati.conf
│ └── postgres
│ ├── Dockerfile
│ └── sql
│ └── init.sql
└── docker-compose.yml
$ pipenv install
Settings configuration by creating .env file on root project
$ cp .env.example .env
Edit file and change the params
$ make db-upgrade
$ make run-server
$ docker build -t repodevs/banaspati:1.0 .
$ docker run -d --name banaspati-dev -e "SQLALCHEMY_DATABASE_URI=postgres://banaspatidbuser@db:5432/banaspatidev" --link postgres-banaspati:db -p 8338:8338 repodevs/banaspati:1.0
NOTE: Need database (postgres) to run
$ docker-compose up -d --build
$ docker exec banaspati-api bash -c "cd core/migrations && alembic upgrade head"
I use HTTPie to test via CLI, Have you try it? :)
$ http POST http://0.0.0.0:8338/book author="Edi Santoso" name="Falcon Book" isbn:=8338
$ http GET http://0.0.0.0:8338/book/{BOOK_ID}
$ http PUT http://0.0.0.0:8338/book/{BOOK_ID} name="Falcon Book for Beginer" isbn:=18338
$ http DELETE http://0.0.0.0:8338/book/{BOOK_ID}
$ http GET http://0.0.0.0:8338/books
This project is inspired from Flusk