Django REST Framework Swagger 2.0

Ответ 1

Вот как мне удалось это сделать:

base urls.py

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

api.urls.py

urlpatterns = [
url(r'^$', schema_view, name='swagger'),
url(r'^article/(?P<pk>[0-9]+)/$', 
    ArticleDetailApiView.as_view(actions={'get': 'get_article_by_id'}), 
    name='article_detail_id'),
url(r'^article/(?P<name>.+)/(?P<pk>[0-9]+)/$', 
    ArticleDetailApiView.as_view(actions={'get': 'get_article'}), 
    name='article_detail'),
]

api.views.py. В MyOpenAPIRenderer я обновляю данные dict, чтобы добавить описание, поля запроса и тип обновления или необходимые функции.

class MyOpenAPIRenderer(OpenAPIRenderer):
    def add_customizations(self, data):
        super(MyOpenAPIRenderer, self).add_customizations(data)
        data['paths']['/article/{name}/{pk}/']['get'].update(
            {'description': 'Some **description**',
             'parameters': [{'description': 'Add some description',
                             'in': 'path',
                             'name': 'pk',
                             'required': True,
                             'type': 'integer'},
                            {'description': 'Add some description',
                             'in': 'path',
                             'name': 'name',
                             'required': True,
                             'type': 'string'},
                            {'description': 'Add some description',
                             'in': 'query',
                             'name': 'a_query_param',
                             'required': True,
                             'type': 'boolean'},
                            ]
             })
        # data['paths']['/article/{pk}/']['get'].update({...})
        data['basePath'] = '/api'  

@api_view()
@renderer_classes([MyOpenAPIRenderer, SwaggerUIRenderer])
def schema_view(request):
    generator = SchemaGenerator(title='A title', urlconf='api.urls')
    schema = generator.get_schema(request=request)
    return Response(schema)


class ArticleDetailApiView(ViewSet):

    @detail_route(renderer_classes=(StaticHTMLRenderer,))
    def get_article_by_id(self, request, pk):
        pass

    @detail_route(renderer_classes=(StaticHTMLRenderer,))
    def get_article(self, request, name, pk):
        pass

обновление для django-rest-swagger (2.0.7): заменить только add_customizations с помощью get_customizations.

views.py

class MyOpenAPIRenderer(OpenAPIRenderer):
    def get_customizations(self):
        data = super(MyOpenAPIRenderer, self).get_customizations()
        data['paths'] = custom_data['paths']
        data['info'] = custom_data['info']
        data['basePath'] = custom_data['basePath']
        return data

Вы можете прочитать спецификацию swagger для создания пользовательских данных.

Ответ 2

Итак, похоже, что произошло django-rest-frameowrk добавлено новое SchemeGenerator, но оно полузапечено и отсутствует способность для генерации описаний действий из документов кода и открыть вопрос об этом, из-за 3.5.0.

В то же время django-rest-swagger пошел дальше и обновил свой код для работы с новым SchemaGenerator, что делает его нарушением изменений пока.

Очень странные серии событий привели к этому): надеясь, что это скоро будет решено. на данный момент предложенный ответ является единственным вариантом.

Ответ 3

РЕДАКТИРОВАТЬ - начиная с версии 2.2.0 и остальной инфраструктуры 3.9.2, создать собственную схему, например:

from rest_framework.schemas import AutoSchema


class CustomSchema(AutoSchema):
    def get_link(self, path, method, base_url):
        link = super().get_link(path, method, base_url)
        link._fields += self.get_core_fields()
        return link

    def get_core_fields(self):
        return getattr(self.view, 'coreapi_fields', ())

Затем просто используйте настройку DEFAULT_SCHEMA_CLASS.

REST_FRAMEWORK = {
    'DEFAULT_SCHEMA_CLASS': 'common.schema.CustomSchema',
}

! Приведенный ниже подход устарел.

Так как я не мог найти приемлемый вариант здесь я просто создал свой собственный SchemaGenerator, как это:

from rest_framework.schemas import SchemaGenerator


class MySchemaGenerator(SchemaGenerator):   
    title = 'REST API Index'

    def get_link(self, path, method, view):
        link = super(MySchemaGenerator, self).get_link(path, method, view)
        link._fields += self.get_core_fields(view)
        return link

    def get_core_fields(self, view):
        return getattr(view, 'coreapi_fields', ())

Создан вид чванства:

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


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

    def get(self, request):
        generator = MySchemaGenerator()
        schema = generator.get_schema(request=request)

        return Response(schema)

Используйте это представление в urls.py:

url(r'^docs/$', SwaggerSchemaView.as_view()),

Добавьте настраиваемое поле в APIView:

class EmailValidator(APIView):
    coreapi_fields = (
        coreapi.Field(
            name='email',
            location='query',
            required=True,
            description='Email Address to be validated',
            type='string'
        ),
    )

    def get(self, request):
        return Response('something')

Ответ 4

Использование предлагаемого решения немного хакерское, но работает отлично, можно столкнуться с несколькими проблемами, реализующими предлагаемое решение, но этот документ объясняет интеграцию django rest swagger 2, а также проблемы, стоящие за шагом: полная документация Django Rest Swagger 2

Много позже, но это может помочь кому-то искать помощь сейчас.