nk20/apps/api/urls.py

60 lines
2.0 KiB
Python
Raw Normal View History

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
2020-03-11 10:15:03 +00:00
from django_filters.rest_framework import DjangoFilterBackend
2020-02-06 22:29:17 +00:00
from rest_framework import routers, serializers, viewsets
2020-03-11 10:15:03 +00:00
from rest_framework.filters import SearchFilter
2020-02-18 10:58:42 +00:00
from activity.api.urls import register_activity_urls
from member.api.urls import register_members_urls
from note.api.urls import register_note_urls
from logs.api.urls import register_logs_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-03-07 21:28:59 +00:00
2020-02-06 22:29:17 +00:00
class Meta:
model = User
2020-02-18 11:31:15 +00:00
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-03-11 10:15:03 +00:00
filter_backends = [DjangoFilterBackend, SearchFilter]
filterset_fields = ['id', 'username', 'first_name', 'last_name', 'email', 'is_superuser', 'is_staff', 'is_active', ]
search_fields = ['$username', '$first_name', '$last_name', ]
2020-02-06 22:29:17 +00:00
2020-02-06 22:29:17 +00:00
# Routers provide an easy way of automatically determining the URL conf.
2020-02-18 10:58:42 +00:00
# Register each app API router and user viewset
2020-02-06 22:29:17 +00:00
router = routers.DefaultRouter()
2020-02-08 14:08:55 +00:00
router.register('user', UserViewSet)
register_members_urls(router, 'members')
register_activity_urls(router, 'activity')
register_note_urls(router, 'note')
register_logs_urls(router, 'logs')
2020-02-06 22:29:17 +00:00
2020-02-17 18:44:56 +00:00
app_name = 'api'
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)),
2020-02-17 18:25:33 +00:00
url('^api-auth/', include('rest_framework.urls', namespace='rest_framework')),
]