Decorator for Django REST Framework for validate params
Project description
# django-params-validator
django restframe params validator
use for check django rest api params
用于检查django的rest接口的参数
包括参数的类型、范围
如果参数是bool类型,能将 1, 0转化为布尔值
```bash
pip install django-params-validator
```
# Example
```python
from django_params_validator import Params
@Params(book_num=int, book_num__gte=100, book_num__lte=200, book__optional=False)
def some_interface(request, *args, **kwargs):
pass
@Params(name=str, name__default='jack',
create_datetime=Params.DATETIME_STR, create_datetime__format='%Y-%m-%d',
colors=('red', 'blue', 'yellow'), colors__many=True)
def other_interface(request, *args, **kwargs):
colors = kwargs.get('colors')
# colors = ['']
pass
```
# Options
## TYPE
```name=str```
指定参数的类型
其中Params.DATETIME_STR是特殊的时间戳字符串格式
## gt/lt/gte/lte
制定参数的范围
```num__gte=100```
## optional
是否是可选参数
## default
默认值
## many
```colors__many=True```
是否是列表。
django restframe params validator
use for check django rest api params
用于检查django的rest接口的参数
包括参数的类型、范围
如果参数是bool类型,能将 1, 0转化为布尔值
```bash
pip install django-params-validator
```
# Example
```python
from django_params_validator import Params
@Params(book_num=int, book_num__gte=100, book_num__lte=200, book__optional=False)
def some_interface(request, *args, **kwargs):
pass
@Params(name=str, name__default='jack',
create_datetime=Params.DATETIME_STR, create_datetime__format='%Y-%m-%d',
colors=('red', 'blue', 'yellow'), colors__many=True)
def other_interface(request, *args, **kwargs):
colors = kwargs.get('colors')
# colors = ['']
pass
```
# Options
## TYPE
```name=str```
指定参数的类型
其中Params.DATETIME_STR是特殊的时间戳字符串格式
## gt/lt/gte/lte
制定参数的范围
```num__gte=100```
## optional
是否是可选参数
## default
默认值
## many
```colors__many=True```
是否是列表。
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
Close
Hashes for django-params-validator-1.1.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3c97eafc9a424f16278153624960333b20f079a7719a2575bf38a187c5da4905 |
|
MD5 | 188d51087e7c3439149ba82bc4ef15e5 |
|
BLAKE2b-256 | 343c77f9d0b6b9c3e04f76b13df0130ac64da8d80dd844f136b62c6cc80e68b4 |