Как проще и удобнее всего задокументировать REST API на Django?

Question

[borisovdenis]

В проекте на Django есть REST API. Нужно сделать для этого API хорошую документацию. Верстать вручную маркдауном - явно самоубийство. Хотелось бы, какие-то удобные вещи по типу Swagger. Может кто-то знает что-то еще лучше. Подскажите, пожалуйста!)

Comments

[Никита Чуков]

Rest самодельный или используется django rest framework?

[borisovdenis]

Никита Чуков, С использованием django rest framework

[Никита Чуков]

https://django-rest-swagger.readthedocs.io/en/latest/

from rest_framework_swagger.views import get_swagger_view

schema_view = get_swagger_view(title='Showcase API')
urlpatterns = [
    url(r'^$', schema_view, name='swagger'),

    url(r'^pir/$', rest.pir_list),
    url(r'^pir/(?P<pk>[^/]+)/$', rest.pir_detail),

    url('^sprint/',
        include(
            [
                url(r'^$', rest.sprint_list),
                url(r'^by_pir/(?P<pir_pk>[0-9a-f-]+)/$', rest.sprint_list_by_pir),
                url(r'(?P<pk>[0-9a-f-]+)/$', rest.sprint_detail),

            ]
        )),