Mongoengine Model Serializer

Model Serializer that supports MongoEngine, for Django Rest Framework.

Usage

# model
class Blog(Document):
    owner = ReferenceField(User)
    title = StringField()
    extensions = ListField(EmbeddedDocument(BlogExtension))
    tags = ListField(StringField())
    approved = BooleanField()

# serializer
from rest_framework_mongoengine.serializers import MongoEngineModelSerializer

class BlogSerializer(MongoEngineModelSerializer):
    class Meta:
        model = Blog
        depth = 2
        exclude = ('approved', )
        
# urls
urlpatterns = patterns('',
    url(r'^blog/$', views.BlogList.as_view()),
    url(r'^blog/(?P<id>[0-9a-z]+)/$', views.BlogDetail.as_view()),
)

# views
from rest_framework_mongoengine.generics import ListCreateAPIView, RetrieveUpdateDestroyAPIView

class BlogList(ListCreateAPIView):
    queryset = Blog.objects.all()
    serializer_class = BlogSerializer

class BlogDetail(RetrieveUpdateDestroyAPIView):
    queryset = Blog.objects.all()
    serializer_class = BlogSerializer

Notes:

MongoEngine Model Serializer also supports DynamicDocument.
Depth is optional and defaults to 5. It is used for ReferenceField & ListField.

Sample Output

Install

pip install django-rest-framework-mongoengine

Install as package

You can use this library as a package to your project:

Step 1: Installing required files pip install -r requirements.txt
Step 2: make sure you're having a mongodb running locally: mongod
Step 3: Create users and table in dbsqlite and django admin: python manage.py syncdb
Step 4: Run the SampleApp demo: python manage.py runserver

Then run http://localhost:8000/ on your favorite browser to test the interface

Requirements

License

See LICENSE