将 Base Url 添加到 Django Rest Swagger

Question

我找不到将 BASE URL 添加到 django rest swagger 的方法。我尝试添加

SWAGGER_SETTINGS = {
    "base_path": 'localhost:62090/',
}

到settings.py。但是它不起作用。

Answer 1

我找不到在 swagger ui 中显示基数 url 的方法，但我可以在 urls.py 中像这样添加基数 url

schema_view = get_swagger_view(title='Pastebin API',url='/pastebin/')

此代码在主机和指定的 url 之间添加基数 url。

Answer 2

基本上您需要在 OpenAPI JSON 响应上设置 basePath。要做到这一点 django_rest_swagger:

renderers.py:

from __future__ import absolute_import, division, print_function, unicode_literals

from django.core.urlresolvers import reverse
from rest_framework_swagger import renderers


class OpenAPIRenderer(renderers.OpenAPIRenderer):
    def get_customizations(self):
        data = super(OpenAPIRenderer, self).get_customizations()
        data['basePath'] = reverse('api-root')  # your base url here
        return data

views.py:

from rest_framework import exceptions
from rest_framework.permissions import AllowAny
from rest_framework.renderers import CoreJSONRenderer
from rest_framework.response import Response
from rest_framework.schemas import SchemaGenerator
from rest_framework.views import APIView
from rest_framework_swagger import renderers

from .renderers import OpenAPIRenderer


class SwaggerSchemaView(APIView):
    _ignore_model_permissions = True
    exclude_from_schema = True
    permission_classes = [AllowAny]
    renderer_classes = [
        CoreJSONRenderer,
        OpenAPIRenderer,  # your OpenAPIRenderer here
        renderers.SwaggerUIRenderer
    ]

    def get(self, request):
        generator = SchemaGenerator(
            title=title,
            url=url,
            patterns=patterns,
            urlconf=urlconf
        )
        schema = generator.get_schema(request=request)

        if not schema:
            raise exceptions.ValidationError(
                'The schema generator did not return a schema Document'
            )

        return Response(schema)

urls.py:

from django.conf.urls import url

from . import views

urlpatterns = [
    url(r'^$', views.SwaggerSchemaView.as_view(), name='api-root'),  # your swagger view here
]

将 Base Url 添加到 Django Rest Swagger

Add Base Url to Django Rest Swagger

django-rest-framework

swagger-ui

django-rest-swagger