nk20/apps/api/urls.py

61 lines
2.5 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-06 22:43:56 +00:00
from member.serializers import ProfileViewSet, ClubViewSet, RoleViewSet, MembershipViewSet
2020-02-06 22:49:33 +00:00
from activity.serializers import ActivityTypeViewSet, ActivityViewSet, GuestViewSet
2020-02-06 23:12:00 +00:00
from note.serializers import NoteViewSet, NoteClubViewSet, NoteUserViewSet, NoteSpecialViewSet, \
TransactionViewSet, TransactionTemplateViewSet, MembershipTransactionViewSet
2020-02-06 22:29:17 +00:00
class UserSerializer(serializers.HyperlinkedModelSerializer):
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
2020-02-06 23:12:00 +00:00
fields = ('username', 'first_name', 'last_name', 'email', 'is_staff',)
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
# Routers provide an easy way of automatically determining the URL conf.
router = routers.DefaultRouter()
router.register(r'users', UserViewSet)
2020-02-06 22:49:33 +00:00
2020-02-06 23:29:04 +00:00
# Routers for members app
2020-02-06 23:12:00 +00:00
router.register(r'members/profile', ProfileViewSet)
router.register(r'members/club', ClubViewSet)
router.register(r'members/role', RoleViewSet)
router.register(r'members/membership', MembershipViewSet)
2020-02-06 22:49:33 +00:00
2020-02-06 23:29:04 +00:00
# Routers for activity app
2020-02-06 23:12:00 +00:00
router.register(r'activity/activity', ActivityViewSet)
router.register(r'activity/type', ActivityTypeViewSet)
router.register(r'activity/guest', GuestViewSet)
2020-02-06 23:29:04 +00:00
# Routers for note app
2020-02-06 23:12:00 +00:00
router.register(r'note/note', NoteViewSet)
router.register(r'note/club', NoteClubViewSet)
router.register(r'note/user', NoteUserViewSet)
router.register(r'note/special', NoteSpecialViewSet)
2020-02-06 23:29:04 +00:00
router.register(r'note/transaction/transaction', TransactionViewSet)
2020-02-06 23:12:00 +00:00
router.register(r'note/transaction/template', TransactionTemplateViewSet)
router.register(r'note/transaction/membership', MembershipTransactionViewSet)
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(r'^', include(router.urls)),
url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]