nk20/apps/api/urls.py

54 lines
1.6 KiB
Python
Raw Normal View History

2020-02-06 22:29:17 +00:00
# -*- mode: python; coding: utf-8 -*-
2020-02-06 22:44:59 +00:00
# Copyright (C) 2018-2020 by BDE ENS Paris-Saclay
2020-02-06 22:29:17 +00:00
# SPDX-License-Identifier: GPL-3.0-or-later
from django.conf.urls import url, include
from django.contrib.auth.models import User
from rest_framework import routers, serializers, viewsets
2020-02-08 14:08:55 +00:00
2020-02-07 16:02:07 +00:00
from .activity.urls import register_activity_urls
from .members.urls import register_members_urls
from .note.urls import register_note_urls
2020-02-06 22:29:17 +00:00
2020-02-07 19:47:49 +00:00
class UserSerializer(serializers.ModelSerializer):
2020-02-06 23:29:04 +00:00
"""
REST API Serializer for Users.
The djangorestframework plugin will analyse the model `User` and parse all fields in the API.
"""
2020-02-06 22:29:17 +00:00
class Meta:
model = User
exclude = ('password', 'groups', 'user_permissions',)
2020-02-06 22:29:17 +00:00
2020-02-06 22:29:17 +00:00
class UserViewSet(viewsets.ModelViewSet):
2020-02-06 23:29:04 +00:00
"""
REST API View set.
The djangorestframework plugin will get all `User` objects, serialize it to JSON with the given serializer,
then render it on /api/users/
"""
2020-02-06 22:29:17 +00:00
queryset = User.objects.all()
serializer_class = UserSerializer
2020-02-06 22:29:17 +00:00
# Routers provide an easy way of automatically determining the URL conf.
router = routers.DefaultRouter()
2020-02-08 14:08:55 +00:00
router.register('user', UserViewSet)
2020-02-06 22:49:33 +00:00
2020-02-06 23:29:04 +00:00
# Routers for members app
register_members_urls(router, 'members')
2020-02-06 22:49:33 +00:00
2020-02-06 23:29:04 +00:00
# Routers for activity app
register_activity_urls(router, 'activity')
2020-02-06 23:12:00 +00:00
2020-02-06 23:29:04 +00:00
# Routers for note app
register_note_urls(router, 'note')
2020-02-06 22:29:17 +00:00
# Wire up our API using automatic URL routing.
# Additionally, we include login URLs for the browsable API.
urlpatterns = [
url('^', include(router.urls)),
url('^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]