Как изменить хост в следующем ключе в URL-адресе с разбивкой на страницы в django rest framework? - PullRequest
Новая
       22

Как изменить хост в следующем ключе в URL-адресе с разбивкой на страницы в django rest framework?

1 голос
/ 17 июня 2020

У меня есть ModelSerializer в Django Rest Framework с разбиением на страницы ответов. Итак, я развернул его с помощью Gunicorn в контейнере docker.

gunicorn -c gunicorn_config.py app.wsgi --bind 0.0.0.0:5000

Теперь проблема заключается в разбивке на страницы ответов. Ключ next выглядит примерно так.

next: "http://0.0.0.0:5000/admin/users/?page=2&per_page=10"

На моей стороне клиента, где я использую эти API, я просто проверяю ключ next и получаю следующий ответ. Но поскольку ключ next имеет хост как 0.0.0.0:5000, это приведет к сбою вызова API. И цель не используется для ключа next.

Итак, в настоящий момент мой сервер API работает в отдельном контейнере docker. Которая настраивается через обратный прокси в nginx.

Ответы [ 2 ]

2 голосов
/ 17 июня 2020

Ссылка next в пагинаторе DRF генерируется с использованием имени хоста из запроса. Вот как определяется имя хоста в запросе: 

def _get_raw_host(self):
    """
    Return the HTTP host using the environment or request headers. Skip
    allowed hosts protection, so may return an insecure host.
    """
    # We try three options, in order of decreasing preference.
    if settings.USE_X_FORWARDED_HOST and (
            'HTTP_X_FORWARDED_HOST' in self.META):
        host = self.META['HTTP_X_FORWARDED_HOST']
    elif 'HTTP_HOST' in self.META:
        host = self.META['HTTP_HOST']
    else:
        # Reconstruct the host using the algorithm from PEP 333.
        host = self.META['SERVER_NAME']
        server_port = self.get_port()
        if server_port != ('443' if self.is_secure() else '80'):
            host = '%s:%s' % (host, server_port)
    return host

Итак, проверьте, задает ли заголовок HTTP_X_FORWARDED_HOST правильное имя хоста, которое вам нужно, и если да, установите USE_X_FORWARDED_HOST на True в своих настройках. Также убедитесь, что нужное имя хоста добавлено к ALLOWED_HOSTS.

. Вы также можете переопределить метод get_next_link() в классе PageNumberPagination, чтобы указать необходимое имя хоста / домена

0 голосов
/ 17 июня 2020

Итак, я создал собственный класс разбиения на страницы, расширяющий PageNumberPagination

from rest_framework.pagination import PageNumberPagination
def replace_query_param(url, key, val):
    """
    Given a URL and a key/val pair, set or replace an item in the query
    parameters of the URL, and return the new URL.
    """
    (scheme, netloc, path, query, fragment) = parse.urlsplit(force_str(url))
    scheme = "https"
    netloc = "api.example.com"
    query_dict = parse.parse_qs(query, keep_blank_values=True)
    query_dict[force_str(key)] = [force_str(val)]
    query = parse.urlencode(sorted(list(query_dict.items())), doseq=True)
    return parse.urlunsplit((scheme, netloc, path, query, fragment))


def remove_query_param(url, key):
    """
    Given a URL and a key/val pair, remove an item in the query
    parameters of the URL, and return the new URL.
    """
    (scheme, netloc, path, query, fragment) = parse.urlsplit(force_str(url))
    scheme = "https"
    netloc = "api.example.com"
    query_dict = parse.parse_qs(query, keep_blank_values=True)
    query_dict.pop(key, None)
    query = parse.urlencode(sorted(list(query_dict.items())), doseq=True)
    return parse.urlunsplit((scheme, netloc, path, query, fragment))

class LargeResultsSetPagination(PageNumberPagination):
    page_size = 1000
    page_size_query_param = 'per_page'
    max_page_size = 1000

    def get_next_link(self):
        if not self.page.has_next():
            return None
        url = self.request.build_absolute_uri()
        page_number = self.page.next_page_number()
        return replace_query_param(url, self.page_query_param, page_number)

    def get_previous_link(self):
        if not self.page.has_previous():
            return None
        url = self.request.build_absolute_uri()
        page_number = self.page.previous_page_number()
        if page_number == 1:
            return remove_query_param(url, self.page_query_param)
        return replace_query_param(url, self.page_query_param, page_number)

Теперь я использую этот класс разбиения на страницы во всех своих ViewSets

class TestViewSet(viewsets.ModelViewSet):
    permission_classes = [permissions.IsAuthenticated]

    queryset = Test.objects.all().order_by("pk")
    serializer_class = test_serializers.TestSerializer
    pagination_class = LargeResultsSetPagination
    search_fields = ['name', 'description', 'follow_up', 'follow_up_type']
    filter_backends = (filters.SearchFilter,)

И он выполняет свою работу. , оригинальное вдохновение { ссылка }

...