Skip to content

Commit a04da32

Browse files
authored
Update README.md
1 parent 780e7ee commit a04da32

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,10 @@ You will see the automatic interactive API documentation (provided by Swagger UI
7979
![Auto generated APIs List](https://github.com/freemindcore/django-api-framework/blob/fae8209a8d08c55daf75ac3a4619fe62b8ef3af6/docs/images/admin_apis_list.png)
8080

8181
#### Auto generation configuration
82-
If AUTO_ADMIN_ENABLED_ALL_APPS is set to True (default), all app models CRUD apis will be generated.
83-
Apps in the AUTO_ADMIN_EXCLUDE_APPS list, will be always excluded.
82+
If `AUTO_ADMIN_ENABLED_ALL_APPS` is set to True (default), all app models CRUD apis will be generated.
83+
Apps in the `AUTO_ADMIN_EXCLUDE_APPS` list, will be always excluded.
8484

85-
If AUTO_ADMIN_ENABLED_ALL_APPS is set to False, only apps in the AUTO_ADMIN_INCLUDE_APPS list will have CRUD apis generated.
85+
If `AUTO_ADMIN_ENABLED_ALL_APPS` is set to False, only apps in the `AUTO_ADMIN_INCLUDE_APPS` list will have CRUD apis generated.
8686

8787
Also, configuration is possible for each model, via ApiMeta class:
8888
- `generate_crud`: whether to create crud api, default to True
@@ -92,9 +92,8 @@ Also, configuration is possible for each model, via ApiMeta class:
9292
- `model_recursive`: recursively retrieve FK/OneToOne fields, default to False
9393
- `sensitive_fields`: fields to be ignored
9494

95-
```
96-
9795
Example:
96+
```
9897
class Category(TestBaseModel):
9998
title = models.CharField(max_length=100)
10099
status = models.PositiveSmallIntegerField(default=1, null=True)
@@ -108,10 +107,11 @@ class Category(TestBaseModel):
108107
```
109108

110109
### Adding CRUD APIs to a specific API Controller
111-
By inheriting CrudAPIController class, CRUD APIs can be added to any API controller.
112-
Configuration is available via Meta inner class in your Controller, same as the above ApiMeta inner class defined in your Django models.
110+
By inheriting `CrudAPIController` class, CRUD APIs can be added to any API controller.
111+
Configuration is available via `Meta` inner class in your Controller, same as the above `ApiMeta` inner class defined in your Django models.
113112

114113
Example:
114+
115115
```
116116
@api_controller("event_api", permissions=[AdminSitePermission])
117117
class EventAPIController(CrudAPIController):

0 commit comments

Comments
 (0)