Metadata-Version: 2.1
Name: django_admin_page_api
Version: 1.0.2
Summary: Django Admin Page API
Home-page: https://github.com/mateuszzebala/django-admin-page-api
Author: Mateusz Zębala
Author-email: mateusz.zebala.pl@gmail.com
License: MIT
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: django

# Django Admin Page API

[Django Admin Page API](https://pypi.org/project/django-admin-page-api/)

## Instalation

Run a command:

```bash 
pip install django-admin-page-api
```

Make changes in your project:

```py
# urls.py

from django_admin_page_api import sites

urlpatterns = [
    ...
    path('admin-api/', sites.urls),
    ...
]
```

```py
# settings.py

INSTALLED_APPS = [
    ...
    'django_admin_page_api',
    ...
]
```

# Endpoints


## `/admin-api/`

- GET - Fetch list of models available in django admin

## `/admin-api/<app_label>/<model_name>`

- GET - Fetch model info 

- POST - Create new instance of model

## `/admin-api/<app_label>/<model_name>/items` 

- GET - List of items 
    - Search params:
        - offset
        - limit
        - query
        - sort
        - asc
- DELETE - Delete items
    - Request body:
        - keys - list of primary keys to delete (mey be separated by commas)

## `/admin-api/<app_label>/<model_name>/<pk>` 
- GET - Fetch item data
- PUT - Update instance of the object and save
- DELETE - Delete item

## `/admin-api/<app_label>/<model_name>/<pk>/<field_name>/`
- GET - get possible value to relation
    - Search params:
        - offset
        - limit
        - query
        - sort
        - asc

## `/admin-api/signin`
- Request body:
    - username
    - password

## `/admin-api/signout`

## `/admin-api/info`

- GET - Fetch current user and session data








