Package: mindbogglr-drf-autodocs
# Django REST framework auto docs# mindbogglr-drf_autodocs[![Latest PyPI version](https://badge.fury.io/py/mindbogglr-drf_autodocs.svg)](https://pypi.python.org/pypi/mindbogglr-drf_autodocs)Forked from: [drf_autodocs](https://github.com/iMakedonsky/drf-autodocs/tree/06c2d1d5a9cd23e698310dbce6100463bd8c3f46)Added support for ManifestFilesMixin when url for fonts is pointing to a non-existant file in css.# Original ReadMeAutomated api documentation renderer### Features:* optional response_serializer_class, if output serializer is different from input serializer* fully-documented functional views* tree-like structure* Docstrings:* markdown* preserve space & newlines* formatting with nice syntax* Fields:* different fields for request/response, based on read-/write-only attributes and whether response_serializer_class presented or not* choices rendering* help_text rendering (to specify SerializerMethodField output, etc)* Endpoint properties:* filter_backends* authentication_classes* permission_classes* extra url params(GET params)### What isn't supported yet:* viewsets* possibility to try in browser# Samples#### Whole structure:![whole structure](http://joxi.ru/52aBGNI4k3oyA0.jpg)#### Single node:![single node](http://joxi.ru/E2ppYWh94VdV2Y.jpg)#### Choices:![choices](http://joxi.ru/D2PdaVspB1M423.jpg)#### Nested items:![nested items](http://joxi.ru/vAWOkRt1BKY4AW.jpg)#### Docstring formatting:```python@format_docstring(request_example, response_example=response_example)class BookReadUpdateHandler(RetrieveUpdateAPIView):"""Wow, this magic decorator allows us to:1) Keep clean & short docstring2) Insert additional data in it, like request/response examplesRequest: {}Response: {response_example}"""```![help text](http://joxi.ru/VrwzKWSO4YekAX.jpg)# InstallationIn virtualenv:pip install drf_autodocsIn settings:INSTALLED_APPS = [...'drf_autodocs',...]In your urls:urlpatterns = [...url(r'^', include('drf_autodocs.urls')),]That's already enough for swagger-like docs,result available on`localhost:8000/docs/`If you want functional views support and some more features, read below.# Usage### Tree-like structureTree-like structure is built from url prefixes. To make your endpoints grouped by somecategory, you must include your urls within other url. There are, generally, 2 ways to achieve it:Example 1:```pythonuniversity_urlpatterns = [url(r'^lecturers/', university_views.LecturersHandler.as_view(), name='lecturers'),url(r'^lecturers/(?P<pk>\d+)/$', university_views.LecturerUpdateHandler.as_view(), name='lecturer_read_update'),url(r'^universities/', university_views.UniversitiesHandler.as_view(), name='universities'),]urlpatterns = [url(r'^library/', include(library_urlpatterns, namespace='library')),url(r'^university/', include(university_urlpatterns, namespace='university')),]```Example 2:```pythonurlpatterns = [url(r'^library/', include(library_urlpatterns, namespace='library')),url(r'^university/', include([url(r'^lecturers/', university_views.LecturersHandler.as_view(), name='lecturers'),url(r'^lecturers/(?P<pk>\d+)/$', university_views.LecturerUpdateHandler.as_view(), name='lecturer_read_update'),url(r'^universities/', university_views.UniversitiesHandler.as_view(), name='universities')], namespace='university')),]```### Response serializer classSay you have a view like this:```pythonclass BookReadUpdateHandler(RetrieveUpdateAPIView):serializer_class = BookUpdateSerializerqueryset = Book.objects.all()```And say this serializers' input is different from output:```pythonclass BookUpdateSerializer(serializers.ModelSerializer):class Meta:fields = ('name', 'author')model = Bookdef to_representation(self, instance):return LibrarySerializer(instance.library)```Now to know what return format is, one must make a request.This package simplifies it via:`response_serializer_class = YourSerializer`Now your view looks like:```pythonclass BookReadUpdateHandler(RetrieveUpdateAPIView):"""Shiny and nice docstring, which:1) allows formatting2) `allows markdown`"""serializer_class = BookUpdateSerializerresponse_serializer_class = LibrarySerializerqueryset = Book.objects.all()```### Docstring formatting in class-based views```pythonfrom .request_response_examples import request_example, response_examplefrom drf_autodocs.decorators import format_docstring@format_docstring(request_example, response_example=response_example)class BookReadUpdateHandler(RetrieveUpdateAPIView):"""Wow, this magic decorator allows us to:1) Keep clean & short docstring2) Insert additional data in it, like request/response examplesRequest: {}Response: {response_example}"""serializer_class = BookUpdateSerializerresponse_serializer_class = LibrarySerializerqueryset = Book.objects.all()```### Extra URL(GET) parametersPlease think twice before using such parameters, as they might be unneeded.But if you really need them, here you go:```pythonclass LibrariesHandler(ListCreateAPIView):"""Shiny and nice docstring, which:1) allows formatting2) `allows markdown`"""extra_url_params = (('show_all', 'Bool', 'if True returns all instances and only 5 otherwise'),('some_extra_param', 'Integer', 'Something more to be included there'))```Results in:![extra_url_params](http://joxi.ru/E2ppYWh9GMzJ2Y.jpg)### Function-based viewsFor functional views, decorate them with.`drf_autodocs.decorators.document_func_view`Now you can insert into view via kwargs:* serializer_class* response_serializer_class* filter_backends* authentication_classes* permission_classes* doc_format_args* doc_format_kwargsNow it should look like:```pythonfrom drf_autodocs.decorators import document_func_viewformat_args = ['"This string\nwas inserted"',]@document_func_view(serializer_class=BookSerializer,response_serializer_class=LibrarySerializer,doc_format_args=format_args)@api_view(['GET', 'POST', 'DELETE'])def hello_world(request):"""Works for `functional` views too!Yeah, that thing rocks!And allows formatting {}"""return Response('hello_world response')```### Help textThis package uses default DRF field attribute `help_text`If you're using `ModelSerializer`, and model field got `help_text` attr, it will betransferred to your serializers' field automatically.Example:```pythonfrom rest_framework import serializershas_books = serializers.SerializerMethodField(help_text='returns Bool')```Note that specifying help_text on serializers' field overrides the one from model# CustomizationTo change application look & feel, override templates and/or static files.Root template is :`templates/drf_autodocs/index.html`For additional parsers(if you want other structure than tree), inherit from`drf_autodocs.parser.BaseAPIParser`# Configuration/settingsEndpoint names could use view names or url names, replacing '_' and '-' with ' ' and capitalizing output.Default behavior is to use url names:`url(r'^books/(?P<pk>\d+)/$', library_views.BookReadUpdateHandler.as_view(), name='book_read_update'),`will result in:![url_name](http://joxi.ru/Q2K1WDh4yXnGrj.jpg)If you want to use endpoint(view) names instead, do this in settings:`AUTODOCS_ENDPOINT_NAMES = "view"`# Supports- Python 3- Django 1.8+- Django Rest Framework 3+# CreditsThanks to [django](http://djangoproject.com), [django-REST](http://www.django-rest-framework.org/) for their awesome work,and [drf-docs](https://github.com/manosim/django-rest-framework-docs) for source of inspiration as well as some parts of code.Developed with care by Mashianov Oleksander at[![buddhasoft](http://i63.tinypic.com/2h87nzm.png)](http://buddhasoft.net/)If you :thumbsup: this, don't forget to :star: it and share with friends.