Skip to content

Commit 8fe4fa5

Browse files
committed
doc: Update README.md
1 parent 0ca1392 commit 8fe4fa5

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,13 @@
1010

1111
### Easy and Fast Django REST framework based on Django-Ninja-Extra
1212

13-
- CRUD Async API Generation: Automatic and configurable, inspired by [NextJs-Crud](https://github.com/nestjsx/crud).
13+
- CRUD API Generation: Automatic and configurable, inspired by [NextJs-Crud](https://github.com/nestjsx/crud).
14+
- Zero coding needed to get all your django app's async CRUD API up and running, with Django RBAC security protection
15+
- Prefetch and retrieve all m2m fields if needed
16+
- Recursively retrieve all FK/OneToOne fields if needed
17+
- Excluding fields you do not want
1418
- Domain/Service/Controller Base Structure: for better code organization.
15-
- Base Permission/Response/Exception Classes: and many handy features to help your API coding easier
19+
- Base Permission/Response/Exception Classes: and some handy features to help your API coding easier.
1620
- Pure class based [Django-Ninja](https://github.com/vitalik/django-ninja) APIs: thanks to [Django-Ninja-Extra](https://github.com/eadwinCode/django-ninja-extra)
1721

1822
```
@@ -34,7 +38,7 @@ Plus Extra:
3438
- Python >= 3.6
3539
- Django >= 3.1
3640
- pydantic >= 1.6
37-
- Django-Ninja-extra >= 0.15.0
41+
- Django-Ninja-Extra >= 0.15.0
3842

3943
### Install
4044
`pip install django-api-framework`
@@ -78,7 +82,7 @@ Now go to http://127.0.0.1:8000/api_admin/v1/docs
7882
You will see the automatic interactive API documentation (provided by Swagger UI).
7983
![Auto generated APIs List](https://github.com/freemindcore/django-api-framework/blob/fae8209a8d08c55daf75ac3a4619fe62b8ef3af6/docs/images/admin_apis_list.png)
8084

81-
#### Auto generation configuration
85+
#### Configuration
8286
If `AUTO_ADMIN_ENABLED_ALL_APPS` is set to True (default), all app models CRUD apis will be generated.
8387
Apps in the `AUTO_ADMIN_EXCLUDE_APPS` list, will be always excluded.
8488

@@ -135,7 +139,7 @@ A boilerplate Django project for quickly getting started, and get production rea
135139
https://github.com/freemindcore/django-easy-api
136140

137141
![Auto generated APIs - Users](https://github.com/freemindcore/django-api-framework/blob/9aa26e92b6fd79f4d9db422ec450fe62d4cd97b9/docs/images/user_admin_api.png)
138-
![Auto generated APIs - Schema](https://github.com/freemindcore/django-api-framework/blob/9aa26e92b6fd79f4d9db422ec450fe62d4cd97b9/docs/images/auto_api_demo_2.png)
142+
139143

140144
### Thanks to your help
141145
**_If you find this project useful, please give your stars to support this open-source project. :) Thank you !_**

0 commit comments

Comments
 (0)