Как я могу сгенерировать stati c api документацию для django rest API?

Question

Я просмотрел документацию и попытался использовать swagger и coreapi, но оба они интерактивны, я хочу одну и ту же документацию API без взаимодействия. Является ли это возможным?

Здесь вы можете увидеть документацию API

https://editor.swagger.io/

, но его взаимодействие с соответствующими API-интерфейсами. Я хочу такой же интерфейс и без взаимодействия.

Answer 1

О, это действительно просто.

1. Первая установка: django -rest-swagger == 2.1.2
2. Добавить в настройки: 'rest_framework_swagger'

Далее внесите изменения в urls.py:

from rest_framework_swagger.renderers import SwaggerUIRenderer, OpenAPIRenderer
from rest_framework_jwt.authentication import JSONWebTokenAuthentication
from rest_framework import permissions
from rest_framework.renderers import CoreJSONRenderer
from rest_framework.schemas import get_schema_view

schema_view = get_schema_view(
    title='Swagger My - API documentation',
    public=True,
    renderer_classes=[CoreJSONRenderer, OpenAPIRenderer, SwaggerUIRenderer],
    authentication_classes=[JSONWebTokenAuthentication],
    permission_classes=[permissions.AllowAny]
)

urlpatterns = [
    # Swagger
    path('docs/', schema_view),
]

И вы выберете renderer_classes = [CoreJSONRenderer, OpenAPIRenderer, SwaggerUIRenderer].

Это пример с JWT JSONWebTokenAuthentication для аутентификации.