Вопросы по теме 'springdoc'
java.lang.IllegalStateException: невозможно прочитать метаданные для класса при реализации открытого API с загрузкой Spring
Я пытаюсь реализовать Open API Doc и Open API UI с помощью Spring внутри Spring Boot:
Для этого я ссылаюсь на следующее руководство: https://www.baeldung.com/spring-rest-openapi-documentation
Зависимости в maven следующие:...
6470 просмотров
schedule
07.05.2023
Невозможно отобразить настраиваемый заголовок в пользовательском интерфейсе Open API
Как установить собственный заголовок при использовании Open API 3? Я использую пример Spring Boot + springdoc-openapi-ui. В этом примере я хочу передать в запросе разные заголовки. В приведенных ниже конфигурациях не отображается возможность выбора...
1625 просмотров
schedule
09.06.2022
Почему поле предиката в классе RouterFunctions.DefaultRouterFunction ‹T extends ServerResponse› получает DefaultErrorWebExceptionHandler?
Я использую библиотеку 'org.springdoc:springdoc-openapi-webflux-ui:1.2.28' для отображения документации API пользовательского интерфейса Swagger в моем приложении с весенней загрузкой. http://localhost:8080/swagger-ui.html не работает, он...
112 просмотров
schedule
16.08.2022
Включить кнопку авторизации в springdoc-openapi-ui для аутентификации токена-носителя (JWT)
Как включить кнопку «Авторизовать» в springdoc-openapi-ui (OpenAPI 3.0 /swagger-ui.html ) для аутентификации токена-носителя, например JWT.
Какие аннотации нужно добавить к классам Spring @Controller и @Configuration ?
10616 просмотров
schedule
16.06.2023
Как я могу игнорировать PathVariable условно в пользовательском интерфейсе swagger с помощью springdoc openapi
Я перехожу с springfox 2.9.0 на springdoc-openapi-ui 1.2.33. У меня есть требование показать или скрыть PathVariable в пользовательском интерфейсе swagger в зависимости от условия. У меня есть два пути, как показано ниже
Строка nameIdentifier...
2079 просмотров
schedule
27.10.2022
Класс ответа по умолчанию в Springdoc
Я пытаюсь добавить модель ошибок по умолчанию для всех конечных точек в моем API для некоторых кодов ошибок.
Я нашел частичное решение, прочитав следующие вопросы:
Springfox - ›Springdoc: Как открыть дополнительные модели...
2141 просмотров
schedule
21.02.2023
Springdoc-openapi разные примеры
Я использую springdoc-openapi для документирования моего REST API. Ошибка возвращается объектом ошибки, имеющим errorCode и message . Я использую аннотацию @Schema для документирования примера. Однако мне нужны разные примеры для разных...
1597 просмотров
schedule
10.09.2022
Как скрыть конечные точки из документации OpenAPI с помощью Springdoc
Springdoc автоматически генерирует документацию API для всех методов обработчика. Даже если аннотаций OpenAPI нет.
Как я могу скрыть конечные точки из документации API?
3453 просмотров
schedule
06.11.2022
Скрытый параметр в springdoc-openapi не работает
У меня есть приложение Spring Boot версии 2.3.0. и springdoc-openapi-webflux-ui в версии 1.4.1.
У меня есть аннотированный параметр в действии, подобном этому.
parameters = {
@Parameter(
hidden = true, schema = @Schema(implementation =...
1763 просмотров
schedule
12.04.2023
springdoc-openapi: как использовать @RouterOperation в coRouter DSL
Я использую springdoc-openapi с Kotlin и WebFlux.fn. Я хотел использовать аннотацию @RouterOperation на каждом пути в CoRouterFunctionDsl, но не смог.
@Configuration
class UserRouter(private val userHandler: UserHandler) {
// @RouterOperations...
912 просмотров
schedule
14.09.2022
Генерация случайных API-документов Springdoc
Я хочу создать api, который принимает другой тип контента.
Проблема, с которой я столкнулся, заключается в том, что если я несколько раз запускаю свое приложение, у меня будет другая выходная документация.
@RestController
public class...
283 просмотров
schedule
20.03.2022
Как изменить текст, присутствующий на экране авторизации swagger, с помощью Springdoc
Я хочу изменить текст, отображаемый на экране пользовательского интерфейса авторизации swagger.
Я хочу изменить метку Разрешено на Сохранено .
Пожалуйста, найдите приведенный ниже снимок экрана с экрана авторизации пользовательского интерфейса...
160 просмотров
schedule
03.07.2023
Springdoc с несколькими API-документами
Я хочу сгруппировать три документа API в одном swagger-ui. Я использую Springdoc. У каждого из трех API-документов есть свой URL-адрес. (Они не в одном проекте). Есть ли способ сделать это?
Изменить: теперь он работает следующим образом:...
208 просмотров
schedule
15.04.2022
В springdocs я могу определить несколько определений OpenAPI на основе тегов операций
Мне нужно определить два разных определения OpenApi с помощью springdocs для одного и того же API в одном приложении: одно для внутренних разработчиков и одно для внешних разработчиков. Внешнее определение будет включать некоторые операции из...
160 просмотров
schedule
23.02.2022
Swagger (OpenAPI): как указать пример строки, динамически сгенерированной из настраиваемого объекта?
Контекст
Скажем, у вас есть:
public class Dto {
private String name;
private String List<String> customs;
// getters and setters...
}
а также
public class Custom {
private String something;
private String else;
//...
269 просмотров
schedule
03.03.2022
SpringDoc app-doc.yaml не показывает документ чванства
У меня есть API с чванством. Пример конечной точки:
@ApiOperation(value = "Returns a list of Pix transactions.",httpMethod = "POST",response = DResponse.class)
@PostMapping("/transactions")
public...
94 просмотров
schedule
23.05.2022
Как интегрировать Swagger с SpringDoc YAML?
Я использую Swagger для документирования своего проекта и хочу сгенерировать документ YAML из springdoc. Но когда я создаю эту документацию YAML, у YAML нет моих документов Swagger. Например. В моем проекте есть одна конечная точка:...
37 просмотров
schedule
11.01.2023
Springdoc OpenAPI отображает отношения классов в схемах и примерах
Я использую springdoc-openapi для документации REST API. У меня есть два класса, между которыми есть отношения «один к одному». После создания API, когда я использую API. Он возвращает именно тот способ, которым он хранится в базе данных, но...
50 просмотров
schedule
11.07.2022
Springdoc-openapi: не отображается правильный тег при инициализации
Я использую springdoc-openapi для создания документации по API и использую $ref для ссылки на внешний файл yaml. Вот моя конфигурация:
tags:
- name: example
description: 'Description for Example'
paths:
/example/{id}/{pathParam2}:...
163 просмотров
schedule
12.07.2022
Автоматическое создание описания на основе аннотаций Swagger в Springdoc
В основном мой вопрос такой же, как этот , но для Springdoc (а не Springfox).
Короче говоря, у меня есть приложение Spring-boot, и я использую аннотацию spring-security @PreAuthorize для защиты некоторых моих API, в настоящее время основанных...
87 просмотров
schedule
03.04.2023