DjangoCRUDify is a powerful and intuitive Django app that automates the generation of CRUD (Create, Read, Update, Delete) APIs for your Django models. With minimal configuration, turn your existing models into a fully functional API, complete with Swagger documentation for seamless integration.
Project description
ModelMagicAPI
DjangoCRUDify is a Django app that provides automatic generation of CRUD APIs for Django models.
Installation
To install crudify, use the following pip command:
pip install DjangoCRUDify
### `docs/configuration.md`
```markdown
# Configuration
After installing crudify, you need to configure it in your Django project.
1. Add 'ModelMagicAPI' to your `INSTALLED_APPS` in your Django project's `settings.py`:
```python
INSTALLED_APPS = [
# ...
'ModelMagicAPI',
# ...
]
from modelmagicapi.utils import router, generate_swagger_schema
urlpatterns = [
# Your other URL patterns
path('api/', include(router.urls)),
path('swagger/', generate_swagger_schema(title="Test Apis", version='v1').with_ui('swagger', cache_timeout=0), name='schema-swagger-ui')
]
(Optional) Configure the models you want to expose by adding the following to your project's settings.py:
AUTO_API_USER_MODELS = ['app_name.Model1', 'app_name.Model2']
### `docs/usage.md`
```markdown
# Usage
After completing the installation and configuration, the CRUD APIs for the specified models will be available at `/api/`.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
DjangoCRUDify-0.3.0.tar.gz
(8.0 kB
view hashes)
Built Distribution
Close
Hashes for DjangoCRUDify-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 41a0dc9494aa1d363ffa26536dfa2ebe3942223a2033c327cfeba59356be3f89 |
|
MD5 | c5fbe206b1b802666df7cbfeb424b273 |
|
BLAKE2b-256 | db2e7d310be4121647b05d8477a8428ad1640948adb28f4b2af3270bef1d1a26 |