Можем ли мы заменить swagger-ui на redo c в Springdoc? - PullRequest
Новая
       23

Можем ли мы заменить swagger-ui на redo c в Springdoc?

2 голосов
/ 21 апреля 2020

Я пытаюсь заменить файл swagger, поддерживаемый вручную, на Springdo c. В настоящее время мы используем ReDo c для рендеринга файла из-за их поддержки discriminator.

Существует ли простой способ заменить / заменить встроенный swagger-ui на ReDoc?

Ответы [ 2 ]

4 голосов
/ 22 апреля 2020

В springdo c вы можете пропустить, используя пакет пользовательского интерфейса Swagger, и использовать вместо него: 

    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-webmvc-core</artifactId>
    </dependency>

. Затем вы можете указать расположение схемы swagger, созданной с помощью springdo c (по умолчанию / v3 / api-docs) в вашем компоненте <redoc />. Остальное зависит от того, как вы размещаете Redo c. В нашем случае мы только что добавили контроллер к нашему сервису / приложению, который обслуживает основные c HTML, описанные на странице документации Redo c (https://github.com/Redocly/redoc#tldr).

2 голосов
/ 22 апреля 2020

Вы можете отключить Swagger-UI по умолчанию с помощью 

springdoc.swagger-ui.enabled=false

, см. Раздел «Отключение Swagger-UI» в https://springdoc.org/

После этого, все, что вам нужно сделать, это установить ReDo c на ваш сервер и указать на описание OpenAPI, как правило, в / context-path / v3 / api-docs
См. раздел «Развертывание» в https://github.com/Redocly/redoc

...