Python CRUD Simple Rest API, using: Django, Postgres, Docker and Docker Compose

Simple REST API to interact with Post and Comment data the Fake API in JSONPlaceholder (Free Fake REST API) using Python 3, Django, Django REST framework and PostgreSQL.

Here is a schema of the architecture used in this application:

This README as the following sections:

• Docker and docker-compose
• Installation
• Commands
• Authentication
• REST APIs
• REST API Tests

🐳 Docker and docker-compose

This section show the three files to Dockerize and run the project.

django.sh

When it will run the app, it will not have the tables in the database, so it need to create the migrations and run them. To do this, I were creating a bash script to execute the commands. It will execute them when it run the djangoapp container.

Get the django.sh here.

Dockerfile

The Dockerfile will contain the instructions to build the project's image.

Get the Dockerfile here.

The ENTRYPOINT ["/django.sh"] line is important. By doing so, we can run the django.sh file when the container starts, with all the necessary instructions. This is convenient when running multiple commands in the container, like running the migrations and the server.

docker-compose.yml

The docker-compose.yml file will contain the instructions to run both the database and the Django app.

Get the docker-compose.yml here.

Note

• For this project I am sharing container image in the Docker Hub, with the source code and the configuration Django.
• Pulls image from the repository: docker pull thober/djangoapp:0.0.2

Run the project

It's now time to run the project.

First of all, let's run the database.

docker-compose up -d db

This will run the database in the background. We can check it using TablePlus.

Let's create a new connection with these parameters:

• Host: localhost
• Port: 5432
• Username: postgres
• Password: postgres
• Database: postgres

Now that the image is built, let's run the Django app (django_thober image).

docker-compose up

⚠️ Don't forget to create a user to use authentication.

python manage.py createsuperuser

🚀 Installation

In this section we will guide how to create a Django REST framework environment used in this project in 6 steps:

1. Install a virtual environment, you must have python pre-installed in your system.

python3.8 -m virtualenv venv

2. Now open a directory and starts the project in a virtual environment. For this, run the following command in that directory.

venv\Scripts\Activate.ps1

3. Open your activated virtual environment and install Django using the following command.

pip install Django==4.1.4

4. Now that we have installed Django Web framework and anothers lib that used in this project.

pip install djangorestframework==3.14.0
# Django-filter is a generic to allows users to filter down a queryset based on a model’s fields.
pip install django-filter==22.1
# Requests is a simple HTTP library. Used to connect with the JSONPlaceholder.  
pip install requests
# Psycopg2 is a  driver for interacting with PostgreSQL from the Python. 
psycopg2-binary==2.9.6

For more details about the requirements this project, see too the requirements.txt

5. After the installation, start a Django project using the command:

django-admin startproject stroer_prj

6. Next, start an app.

python manage.py startapp stroer_app

You just created your Django app for this project.

At this point we have a complete skeleton project. Now we should first run a database migration.

# Running database migrations
python manage.py makemigrations
python manage.py migrate

We'll also create an initial user.

python manage.py createsuperuser

In the last, run the development web server by calling the runserver command.

python manage.py runserver

🔨 Commands

In this project has 3 Django commands to help in the beginning and synchronize the systems.

1. Import all Post and Comments linked with JsonPlaceHolder.

python manage.py import_jsonplaceholder

2. Delete all Post and Comments linked with JsonPlaceHolder.

python manage.py delete_jsonplaceholder

3. Synchronizes the MASTER systems with the JSONPlaceholder API.

Synchronization with Option "forced". Delete all Posts and Comments and re-include.

python manage.py sync_jsonplaceholder -p forced

Synchronization with Option "add". It includes all the Posts and Comments that are in JsonPlaceHolder but not in MASTER.

python manage.py sync_jsonplaceholder -p add

Synchronization with Option "check". This option includes new posts and comments made after the last import.

python manage.py sync_jsonplaceholder -p check

🔒 Authentication

It is very simple to make it work Django authentication, basically what you have to do is create a user as you would normally do in Django and go to a new section that appears in the administrative part of the system to create the Token for that user.

Note There are ways to create tokens automatically, which are explained in the Django Rest framework documentation. After clicking Add, all you have to do is select the user on which we want to create the Token.

In the part of the client that connects to the service, you just have to add the Authorization key: Token in the header of the request, and with this, everything would be.

To use authentication in Postman just include in the Header the Key Authorization with the Value.

🏃‍♂️ REST APIs

This REST API provides an interface for applications to interact with Post and Comment.

POST API

Schema

The schema defines all the fields that exist within a post record.

Field	Description
id	Unique identifier for the post.
user_id	The ID for the author of the post.
title	The title for the post.
body	The content for the post.

List Posts

Query this endpoint to retrieve a collection of posts. The response you receive can be controlled and filtered using the URL query parameters below.

Definitions: GET /post/ | GET /post/id/ | GET /post/?user_id=value | GET /post/?search=text_value

Example Request:

• GET all posts: https://example.com/post/
• Get a post: GET https://example.com/post/1/
• Get all posts by user_id: https://example.com/post/?user_id=1
• Get all post by search in body: https://example.com/post/?search=voluptatem

Create a Post

Arguments: [user_id, title, body]

Definition: POST /post/

Example Request: POST https://example.com/post/

{
    "user_id": "99999942",
    "title": "quis quasi placeat",
    "body": "ut libero sit aut totam inventore sunt porro sint qui sunt molestiae consequatur cupiditate"
}

or simple post (without user_id)

{
    "title": "laboriosam dolor",
    "body": "facilis sit sint culpa\nsoluta assumenda eligendi non ut eius\nsequi ducimus"
}

It is possible only new post with user ID 99999942.

Update a Post

Arguments: [id, title, body]

Definition: PUT /post/id/

Example Request: PUT https://example.com/post/1/

{
    "title": "new title",
    "body": "new body"
}

or partial update

{
    "title": "New Title"
}

Delete a Post

Arguments: [id]

Definition: DELETE /post/id/

Example Request: DELETE https://example.com/post/1/

COMMENT API

Schema

The schema defines all the fields that exist within a comment record.

Field	Description
id	Unique identifier for the comment.
post_id	The ID of the associated post object.
name	Display name for the comment author.
email	Email address for the comment author.
body	The content for the comment.

List Comments

Query this endpoint to retrieve a collection of comments. The response you receive can be controlled and filtered using the URL query parameters below.

Definitions: GET /comment/ | GET /comment/id/ | GET /comment/?post_id=post_value | GET /comment/?email=email_value | GET /post/?search=text_value

Example Request:

• GET all comments: https://example.com/comment/
• Get a comment: GET https://example.com/comment/1/
• Get all comments by post: https://example.com/comment/?post_id=1
• Get all comments by email: https://example.com/comment/?email=Mallory_Kunze%40marie.org
• Get all comments by search in body: https://example.com/comment/?search=voluptatem

Create a Comment

Arguments: [post_id, name, email, body]

Definition: POST /comment/

Example Request: POST https://example.com/comment/

{
   "post_id": 1,
   "name": "et fugit eligendi deleniti quidem qui sint nihil autem",
   "email": "Presley.Mueller@myrl.com",
   "body": "doloribus at sed quis culpa deserunt consectetur qui praesentium"
}

Update a Comment

Arguments: [id, post_id, name, email, body]

Definition: PUT /comment/id/

Example Request: PUT https://example.com/comment/1/

{
   "post_id": 1,
   "name": "new name",
   "email": "new.email@myrl.com",
   "body": "newbody"
}

or partial update

{
   "name": "new name"
}

Delete a Comment

Arguments: [id]

Definition: DELETE /comment/id/

Example Request: DELETE https://example.com/comment/1/

💣 REST API Tests

API tests were created and executed using Postman. We created 42 API tests for most common CRUD operations.

The created tests can be imported into Postman from the file below:

stroer_app.postman_collection.json

See also Importing and exporting data.