Использование внешней документации для конечной точки в пользовательском интерфейсе Swagger

Для определенной конечной точки в нашем REST API я хотел бы предоставить внешнюю документацию.

Существует аргумент external_docs, который может быть передан extend_schema, но я нигде не видел примера.

Я передал только URL-адрес внешней документации:

@extend_schema_view(
    my_specific_endpoint=extend_schema(
        external_docs="https://documentation.example.com"
    )
)
class MySpecificViewSet(ModelViewSet):
    # class contents

Клиенты должны использовать внешнюю документацию, чтобы получить инструкции по использованию.

Эту конечную точку нельзя использовать через пользовательский интерфейс Swagger, и в идеале нужно отключить кнопку "Try it out", если это возможно. Кроме того, я хотел бы отключить секции Parameters и Response.

РЕДАКТИРОВАТЬ:

Аргумент external_docs принимает словарь с определенными ключами, а именно:

external_docs={"url": "https://documentation.example.com", "description": "API documentation"}

Но я все еще ищу возможность отключить кнопку "Попробовать" или кнопку "Выполнить".

Вернуться на верх