django-hug
Package for working with Django urls/views and request/response validation in more convenient way. Inspired by beautiful hug.
Getting Started
Simple API building example with django-hug
In your views module create routes and couple API endpoints.
# views.py
import django_hug
from marshmallow import fields
routes = django_hug.Routes()
@routes.get('new/<int:year>/')
def simple(request, year, month: int):
return {"year": year, "month": month}
@routes.get('happy/<int:year>/')
def mm_field(request, year, month: fields.Int(validate=Range(min=1, max=12)) = 1):
return [year, month]In your urls.py specify new endpoints
from . import views
urlpatterns = views.routes.get_urlpatterns()Thats all, now you can make requests to new API endpoints with convenient data validation
curl http://127.0.0.1:8000/new/2019/?month=133
>> {"year": 2019, "month": 133}and nice errors handling
curl http://127.0.0.1:8000/happy/2019/?month=133
>> {"errors": {"month": ["Must be between 1 and 12."]}}Usage
Regexp path
You can also use regexp path
@routes.get("(?P<year>[0-9]{4})/", re=True)
def index3(request, year, name: str):
loc = locals()
del loc["request"]
return loc
Directives
Use builtin directive body to validate whole POST request
# views.py
import django_hug
from marshmallow import Schema, fields
routes = django_hug.Routes(prefix="api")
class RespSchema(Schema):
id = fields.Int(required=True)
quantity = fields.Int(required=True)
@routes.post("test/")
def view(request, body: RespSchema()):
return bodyRoutes prefix
Specify prefix in Routes object to add prefix to all urls
# views.py
import django_hug
routes = django_hug.Routes(prefix="api")
@routes.get('<int:year>/')
def api_method(request, year, month: int = 1):
return {"year": year, "month": month}curl http://127.0.0.1:8000/api/2019/
>> {"year": 2019, "month": 1}Types
Coming soon
Response and request formatting
Underscore/camelcase transform
Coming soon
To start example app
make venv
source activate
cd example
./manage.py runserverAttention! Work In Progress
TODO
- Full support various view decorators (test_decorators)
- Support multiple routes for one view (?)
- Add exception handler
- Take into account content type for response
- Cleanup tests
