Simple Serializers for API validations
Project description
# Flask-Simple-Serializer
Simple Serializer to valid API request
### Usage
```python
# my_app.serializers.py
from flask_simple_serializer.serializers import Serializer
from flask_simple_serializer import StringField, BooleanField, EmailField, validators
class Userserializer(Serializer):
username = StringField('Username')
email = EmailField('Email Address', [validators.Length(min=4, max=25)])
accept_rules = BooleanField('I accept the site rules', [validators.InputRequired()])
def create_user(self):
pass
# my_app.views.py
from flask_simple_serializer.response import Response
from flask_simple_serializer.status_code import HTTP_200_OK, HTTP_400_BAD_REQUEST
from my_app.serializes import Userserializer
@site.route('/some_route/')
def user_registration():
serializer = UserSerializer(request.json)
if serializer.is_valid()
# Do something
serializer.create_user()
return Response(status_code=HTTP_200_OK)
return Response(serializer.errors, status_code=HTTP_400_BAD_REQUEST)
```
### TODO
- Model Serializer
- Serializer that accept Model instance (SqlAlchemy)
- Improve Documentation
- Custom Felds
- Parse request decorators
- Test for Response and Status Codes
Simple Serializer to valid API request
### Usage
```python
# my_app.serializers.py
from flask_simple_serializer.serializers import Serializer
from flask_simple_serializer import StringField, BooleanField, EmailField, validators
class Userserializer(Serializer):
username = StringField('Username')
email = EmailField('Email Address', [validators.Length(min=4, max=25)])
accept_rules = BooleanField('I accept the site rules', [validators.InputRequired()])
def create_user(self):
pass
# my_app.views.py
from flask_simple_serializer.response import Response
from flask_simple_serializer.status_code import HTTP_200_OK, HTTP_400_BAD_REQUEST
from my_app.serializes import Userserializer
@site.route('/some_route/')
def user_registration():
serializer = UserSerializer(request.json)
if serializer.is_valid()
# Do something
serializer.create_user()
return Response(status_code=HTTP_200_OK)
return Response(serializer.errors, status_code=HTTP_400_BAD_REQUEST)
```
### TODO
- Model Serializer
- Serializer that accept Model instance (SqlAlchemy)
- Improve Documentation
- Custom Felds
- Parse request decorators
- Test for Response and Status Codes
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
Built Distribution
Close
Hashes for Flask-Simple-Serializer-1.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 105bd06f6eab2eae6c6e5790561ac3c23faaa6352a36f6e2ca90c5175dea43b2 |
|
MD5 | a31aa8517211a2d351a3b1eac67ac019 |
|
BLAKE2b-256 | 19c28e9082e6246aa594caba3403a919c90b0e5ae4ef229ed73d1465a87fbf68 |
Close
Hashes for Flask_Simple_Serializer-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2dd92de0474c2c0a8f3391f8bc36fa7911147d9e4ffc8a919fe160e6dec30285 |
|
MD5 | 02bb781c61e1e2b7aaa497b5297273fa |
|
BLAKE2b-256 | c860d9b12ec3aee39844e0cefceaed9720bc860ca34e2a67db0b5ca5694f4b24 |