# 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',
...
]
```
### Important: Data should be send using FormData
# 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 (FormData)
## `/admin-api/<app_label>/<model_name>/<field_name>/autocomplete/`
- GET - get possible value to relation
- Search params:
- offset: number
- limit: number
- query: json string - e.g. {"int_field\_\_gt": 1}
- sort: string
- asc: boolean string
## `/admin-api/<app_label>/<model_name>/items`
- GET - List of items
- Search params:
- offset: number
- limit: number
- query: json string - e.g. {"int_field\_\_gt": 1}
- sort: string
- asc: boolean string
- DELETE - Delete items
- Search params:
- keys - list of primary keys to delete (may be separated by commas)
## `/admin-api/<app_label>/<model_name>/<pk>`
- GET - Fetch item data
- PUT - Update instance of the object and save (FormData)
- DELETE - Delete item
## `/admin-api/<app_label>/<model_name>/<pk>/<field_name>/autocomplete/`
- GET - get possible value to relation
- Search params:
- offset: number
- limit: number
- query: json string - e.g. {"int_field\_\_gt": 1}
- sort: string
- asc: boolean string
## `/admin-api/signin`
- POST - sign in (FormData)
- Request body:
- username: string
- password: string
## `/admin-api/signout`
## `/admin-api/info`
- GET - Fetch current user and session data
## `/admin-api/csrf`
- GET - Fetch csrf token
## `/admin-api/logs`
- GET - Fetch logs of authenticated user
## `/admin-api/<app_label>/<model_name>/action/<action_code>/`
- POST - run model action
- Request body:
- keys - list of primary keys to delete (may be separated by commas)
Raw data
{
"_id": null,
"home_page": "https://github.com/mateuszzebala/django-admin-page-api",
"name": "django-admin-page-api",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Mateusz Z\u0119bala",
"author_email": "mateusz.zebala.pl@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b0/a7/613f692648ba75462a3950758d3c8b83eaa7161c90f2d1d0c4470ba3b506/django_admin_page_api-1.3.1.tar.gz",
"platform": null,
"description": "# Django Admin Page API\r\n\r\n[Django Admin Page API](https://pypi.org/project/django-admin-page-api/)\r\n\r\n## Instalation\r\n\r\nRun a command:\r\n\r\n```bash\r\npip install django-admin-page-api\r\n```\r\n\r\nMake changes in your project:\r\n\r\n```py\r\n# urls.py\r\n\r\nfrom django_admin_page_api import sites\r\n\r\nurlpatterns = [\r\n ...\r\n path('admin-api/', sites.urls),\r\n ...\r\n]\r\n```\r\n\r\n```py\r\n# settings.py\r\n\r\nINSTALLED_APPS = [\r\n ...\r\n 'django_admin_page_api',\r\n ...\r\n]\r\n```\r\n\r\n### Important: Data should be send using FormData\r\n\r\n# Endpoints\r\n\r\n## `/admin-api/`\r\n\r\n- GET - Fetch list of models available in django admin\r\n\r\n## `/admin-api/<app_label>/<model_name>`\r\n\r\n- GET - Fetch model info\r\n\r\n- POST - Create new instance of model (FormData)\r\n\r\n## `/admin-api/<app_label>/<model_name>/<field_name>/autocomplete/`\r\n\r\n- GET - get possible value to relation\r\n - Search params:\r\n - offset: number\r\n - limit: number\r\n - query: json string - e.g. {\"int_field\\_\\_gt\": 1}\r\n - sort: string\r\n - asc: boolean string\r\n\r\n## `/admin-api/<app_label>/<model_name>/items`\r\n\r\n- GET - List of items\r\n - Search params:\r\n - offset: number\r\n - limit: number\r\n - query: json string - e.g. {\"int_field\\_\\_gt\": 1}\r\n - sort: string\r\n - asc: boolean string\r\n- DELETE - Delete items\r\n - Search params:\r\n - keys - list of primary keys to delete (may be separated by commas)\r\n\r\n## `/admin-api/<app_label>/<model_name>/<pk>`\r\n\r\n- GET - Fetch item data\r\n- PUT - Update instance of the object and save (FormData)\r\n- DELETE - Delete item\r\n\r\n## `/admin-api/<app_label>/<model_name>/<pk>/<field_name>/autocomplete/`\r\n\r\n- GET - get possible value to relation\r\n - Search params:\r\n - offset: number\r\n - limit: number\r\n - query: json string - e.g. {\"int_field\\_\\_gt\": 1}\r\n - sort: string\r\n - asc: boolean string\r\n\r\n## `/admin-api/signin`\r\n\r\n- POST - sign in (FormData)\r\n - Request body:\r\n - username: string\r\n - password: string\r\n\r\n## `/admin-api/signout`\r\n\r\n## `/admin-api/info`\r\n\r\n- GET - Fetch current user and session data\r\n\r\n## `/admin-api/csrf`\r\n\r\n- GET - Fetch csrf token\r\n\r\n## `/admin-api/logs`\r\n\r\n- GET - Fetch logs of authenticated user\r\n\r\n## `/admin-api/<app_label>/<model_name>/action/<action_code>/`\r\n\r\n- POST - run model action\r\n - Request body:\r\n - keys - list of primary keys to delete (may be separated by commas)\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Django Admin Page API",
"version": "1.3.1",
"project_urls": {
"Homepage": "https://github.com/mateuszzebala/django-admin-page-api"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bb490a04c00f3c3d6ee9479f55bbbab9663f9262232e6062340d1d36d9f22c48",
"md5": "561a0276957526f31f22ae0e1576e6b7",
"sha256": "6c4bfb2ff60846e9a3fe1ef91cd4254883aabac37149d7a415224deb33c77384"
},
"downloads": -1,
"filename": "django_admin_page_api-1.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "561a0276957526f31f22ae0e1576e6b7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9896,
"upload_time": "2024-09-08T17:00:21",
"upload_time_iso_8601": "2024-09-08T17:00:21.508576Z",
"url": "https://files.pythonhosted.org/packages/bb/49/0a04c00f3c3d6ee9479f55bbbab9663f9262232e6062340d1d36d9f22c48/django_admin_page_api-1.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b0a7613f692648ba75462a3950758d3c8b83eaa7161c90f2d1d0c4470ba3b506",
"md5": "6aebb2e380d78a4115b9e76f1d99af09",
"sha256": "2adebcb1116d84c9df852c98f871af0fb4a7afeed56f725dd22f3229ee73a8e7"
},
"downloads": -1,
"filename": "django_admin_page_api-1.3.1.tar.gz",
"has_sig": false,
"md5_digest": "6aebb2e380d78a4115b9e76f1d99af09",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9044,
"upload_time": "2024-09-08T17:00:22",
"upload_time_iso_8601": "2024-09-08T17:00:22.510323Z",
"url": "https://files.pythonhosted.org/packages/b0/a7/613f692648ba75462a3950758d3c8b83eaa7161c90f2d1d0c4470ba3b506/django_admin_page_api-1.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-08 17:00:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mateuszzebala",
"github_project": "django-admin-page-api",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "django-admin-page-api"
}
JSON
