URL with dot in Django Rest Framework

Question

I have the following model with a primary_key=True specified:

class Team(models.Model):
    name = models.CharField(
        max_length=64,
        primary_key=True,
    )
    ... other fields

When I serialize this model, I do the following:

class TeamSerializer(serializers.ModelSerializer):
   class Meta:
        model = Team
        fields = ('url', 'name',) # and another fields

My viewset:

class TeamViewSet(viewsets.ModelViewSet):
    lookup_value_regex = '[-\w.]'
    queryset = Team.objects.all()
    serializer_class = TeamSerializer
    filter_fields = ('name',) # and another fields

My urls.py:

router = routers.DefaultRouter()
router.register(r'teams', TeamViewSet)

urlpatterns = [
    url(r'^api/', include(router.urls)),

    # I am not sure if this url is right. I repeat of include(router.urls)
    url(r'^api/teams/(?P<name>[-\w.]+)/', include(router.urls)),

    url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]

Then, when I create a Team object with name attribute containing dot ., for example Latinos F.C. and I go to the rest url, I get:

I am not sure about of how to use the lookup_value_regex attribute in my viewset. In this answer is used with some basic regex, but if I use it, any Team object is reachable via my serialized Rest API.

How to can I get a url like as: /api/teams/Name.F.C. in my serialized Team model?

Answer 1

First of all check if you have set APPEND_SLASH to True in your settings, because if not - the missing slash (at the end of the URL) is a problem.

Second - I do not think that dot is a problem, the problem can be a space - coded as %20;

Third - such urls looks just ugly :) You should consider changing it to some kind of a slugs: Latinos F.C. -> latinos-fc;

If you do that (just add additional field on the model with slug - this field should be obviously unique) - set up the lookup_field on your view - this will solve your problem.

Consider the example:

views.py

class SomeViewSet(viewsets.ModelViewSet):
    queryset = SomeModel.objects.all()
    serializer_class = SomeSerializer
    lookup_field = 'slug_name'

serializers.py

class SomeSerializer(serializers.ModelSerializer):

    class Meta:
        model = SomeModel
        fields = ('id', 'name', 'slug_name')
        read_only_fields = ('slug_name',)

    def to_internal_value(self, data):
        ret = super(SomeSerializer, self).to_internal_value(data)
        ret['slug_name'] = slugify(ret['name'])
        return ret

models.py

class SomeModel(models.Model):
    name = models.CharField(max_length=100)
    slug_name = models.SlugField(unique=True, max_length=100)

urls.py

router.register(r'teams', SomeViewSet, base_name='teams')

urlpatterns = router.urls

And now:

creation:

details:

Can you do that this way? Or you really need the dots?