Skip to content

Latest commit

 

History

History
178 lines (157 loc) · 3.04 KB

Readme.md

File metadata and controls

178 lines (157 loc) · 3.04 KB
Raw

Setting up

In order to config the database connection, the following ENV variables needs to be set up:

DB_HOST
DB_PORT
DB_NAME
DB_USER
DB_PASSWORD

Install requirements from requirements.txt

Migrate DB

python manage.py makemigrations
python manage.py migrate

Create admin

python manage.py createsuperuser --email [email protected] --username admin

API instructions

Get all dynamic models in the system

URL:

GET: http://127.0.0.1:8000/api/table/

Response:

Response returns a list of all dynamic models currently available.

[
    {
        "pk": 1,
        "name": "table_1"
    },
    {
        "pk": 2,
        "name": "table_2"
    }
]

Create new model

URL:

POST: http://127.0.0.1:8000/api/table/

Request:

Request must contain the model that we want to create.

{
    "name": "table_3",
    "columns": [{
        "name": "first_column",
        "type": "INTEGER"
    },
    {
        "name": "second_column",
        "type": "STRING"
    }]
}

Response:

Response returns the model that was created or an error if it occurs.

{
    "name": "table_3",
    "columns": [{
        "name": "first_column",
        "type": "INTEGER"
    },
    {
        "name": "second_column",
        "type": "STRING"
    }]
}

Update existing model

URL:

PUT: http://127.0.0.1:8000/api/table/<primary_key>/

Request:

Request must contain the new model definition.

{
    "name": "table_3_renamed",
    "columns": [{
        "name": "first_column",
        "type": "INTEGER"
    },
    {
        "name": "second_column",
        "type": "STRING"
    },
    {
        "name": "third_column",
        "type": "STRING"
    }]
}

Response:

Response returns the new model definition or an error it updates failed.

{
    "name": "table_3_renamed",
    "columns": [{
        "name": "first_column",
        "type": "INTEGER"
    },
    {
        "name": "second_column",
        "type": "STRING"
    },
    {
        "name": "third_column",
        "type": "STRING"
    }]
}

Delete existing model

URL:

DELETE: http://127.0.0.1:8000/api/table/<primary_key>/

Response

Response returns 200 OK if the model was deleted or an error if delete fails.

Get all rows for a model

URL:

GET: http://127.0.0.1:8000/api/table/<primary_key>/rows

Response

Response return a list of all rows currently stored for the model.

[
    {
        "first_column": 1,
        "second_column": "test123",
        "third_column": null
    },
    {
        "first_column": 1,
        "second_column": "test123",
        "third_column": "this works!"
    }
]

Add new row for the model

URL:

GET: http://127.0.0.1:8000/api/table/<primary_key>/row/

Request

Request must contain valid data for selected model.

{
    "first_column": 1,
    "second_column": "test123",
    "third_column": "this works!"
}

Response

Response returns the created row, or an error if insert fails.

{
    "pk": 2,
    "first_column": 1,
    "second_column": "test123",
    "third_column": "this works!"
}