Описание тега springdoc

Библиотека Java springdoc-openapi помогает автоматизировать создание документации API с использованием проектов Spring Boot. springdoc-openapi работает, исследуя приложение во время выполнения, чтобы сделать вывод о семантике API на основе конфигураций Spring, структуры классов и различных аннотаций.
5 ответов

URL-адрес petstore не отключен в SpringDoc OpenAPi

Я использую SpringDoc 1.4.3для чванства. Я добавил конфигурацию ниже, чтобы отключитьpetstore URL-адреса в application.yml Конфигурация springdoc: swagger-ui: disable-swagger-default-url: true tags-sorter: alpha operations-sorter: alpha doc-expansio…
3 ответа

Разрешить анонимный доступ к springdoc-openapi-ui с помощью Spring Security

Как разрешить анонимный доступ к springdoc-openapi-ui (OpenAPI 3.0/swagger-ui.html) в приложении Spring Boot, защищенном Spring Security?
24 янв '20 в 17:27
1 ответ

Spring Boot 2.2.4 проблема с Springdoc OpenApi Swagger V3 hateoas

После интеграции библиотеки springdoc -openapi-data-rest для сопоставления объекта Pageable(spring-date-commons) для исправления параметра URL-адреса в пользовательском интерфейсе Swagger я столкнулся с этой проблемой: *************************** AP…
6 ответов

Как интегрировать Open API 3 с проектом Spring (не Spring Boot) с помощью springdoc-openapi

Мой существующий проект находится на Spring Framework, а не на Spring Boot. Я хочу интегрировать с ним Open API 3. Я хочу выполнить интеграцию с помощью springdoc-openapi, не используя Джерси.
23 янв '20 в 06:29
2 ответа

Переход с springfox swagger2 на springdoc openapi

https://www.dariawan.com/tutorials/spring/documenting-spring-boot-rest-api-springdoc-openapi-3/ Пытаясь следовать этим Как мне работать с аннотациями вроде @ApiModel(value = "Response container") @ApiModelProperty(value = "Iventory response", requir…
11 дек '19 в 20:46
2 ответа

Проблема с представлением данных формы и возвращением массива байтов в Springdoc

У меня есть следующий фрагмент кода, @PostMapping(value = "/create/{userId}", consumes = MediaType.MULTIPART_FORM_DATA_VALUE) public ResponseEntity<Object> saveFile( @Parameter(description = "ID of the user") @PathVariable(value = "userId") fi…
23 июл '20 в 20:18
4 ответа

springdoc-openapi: Как добавить пример POST-запроса?

Есть следующий метод контроллера: @ApiResponses(value = {@ApiResponse(responseCode = "200")}) @GetMapping(value = API_URI_PREFIX + PRODUCTS_URI, produces = MediaType.APPLICATION_JSON_VALUE) @ResponseStatus(HttpStatus.OK) public Flux<Pro…
2 ответа

Swagger 2 или 3 для Spring Data Rest

У меня есть приложение для весенней загрузки, использующее Spring Data Rest. У меня проблема с предоставлением хорошо читаемой документации по API с использованием чванства. Я пробовал spring fox и springdoc, но у каждого свои проблемы Весенняя лиса…
2 ответа

springdoc-openapi-ui Поток кода авторизации OAuth 2.0 с PKCE

Я использую чванство с springdoc-openapi-ui-1.4.3 @SecurityRequirement(name = "security_auth") public class ProductController {} Установка схемы безопасности @SecurityScheme(name = "security_auth", type = SecuritySchemeType.OAUTH2, flows = @OAuthFlo…
2 ответа

Сбой собственного образа GraalVM из-за зависимости Springdoc

Я пытаюсь создать образец приложения, используя загрузку Spring и собственный образ GraalVM, однако, как только я добавляю зависимость для Springdoc, сгенерированный исполняемый файл больше не работает по следующим причинам: java.lang.IllegalStateEx…
2 ответа

Невозможно показать пользовательский заголовок в пользовательском интерфейсе Open API

Как установить собственный заголовок при использовании Open API 3? Я использую пример Spring Boot + springdoc-openapi-ui. В этом примере я хочу передать в запросе разные заголовки. В приведенных ниже конфигурациях не отображается опция выбора заголо…
21 янв '20 в 12:10
1 ответ

Почему поле предиката в классе RouterFunctions.DefaultRouterFunction <T extends ServerResponse> получает DefaultErrorWebExceptionHandler?

Я использую 'org.springdoc:springdoc-openapi-webflux-ui:1.2.28'библиотека для отображения документации API интерфейса Swagger в моем приложении с весенней загрузкой. http://localhost:8080/swagger-ui.html не работает, возвращает: Whitelabel Error Pag…
24 янв '20 в 14:36
4 ответа

Включить кнопку авторизации в springdoc-openapi-ui для аутентификации токена носителя (JWT)

Как включить кнопку "Авторизовать" в springdoc-openapi-ui (OpenAPI 3.0/swagger-ui.html) для аутентификации токена-носителя, например JWT. Какие аннотации нужно добавить в Spring @Controller а также @Configuration классы?
24 янв '20 в 17:56
1 ответ

Включить кнопку авторизации в springdoc-openapi-ui для базовой аутентификации

Как включить кнопку "Авторизовать" в springdoc-openapi-ui (OpenAPI 3.0/swagger-ui.html) для базовой аутентификации. Какие аннотации нужно добавить в Spring @Controller а также @Configuration классы?
24 янв '20 в 17:48
1 ответ

Как глобально игнорировать API Spring Boot из спецификации Open API 3?

Я просмотрел документацию: https://springdoc.github.io/springdoc-openapi-demos/faq.html уже, но документы не очень понятны, У меня есть проект реализации Spring Boot REST HATEOAS и использую спецификацию Open API 3 вместо Swagger. Я реализовал разби…
29 янв '20 в 15:47
1 ответ

Сохранить тот же URL-адрес, но изменить контракт в Spring Boot REST Open API 3?

Я использую Spring Boot and REST and Open API 3реализация. В этом примереv1 В группе есть реализация List - все данные попадут в List, в v2 В группе реализована пагинация - все данные будут приходить в виде страниц. Что касается потребителя, мы не х…
30 янв '20 в 08:57
1 ответ

Как создать несколько схем в @RequestBody спецификации OpenAPI 3.0 Swagger с помощью Springdoc?

У меня есть приведенный ниже api, для которого мне нужно иметь два параметра типа контента application/x-www-form-urlencoded и поэтому я использую @RequestBody вместо того @Parameter @Operation(summary = "Revoke given permissions", description = "Al…
1 ответ

Как я могу изменить макет swagger-ui?

Как я могу изменить макет swagger-ui? Для параметров макета вы можете использовать параметры конфигурации swagger-ui. Что это значит? Например: springdoc.swagger-ui.layout=BaseLayout Какие все варианты доступны?
04 фев '20 в 17:46
1 ответ

Как исключить пути при использовании GroupedOpenAPI с SpringDoc

Недавно я заменил SpringFox на SpringDoc. Раньше я мог исключить пути, которые будут использоваться для пользовательского интерфейса Swagger, например: new Docket(DocumentationType.SWAGGER_2).paths(Predicates.not(PathSelectors.regex("/path1/.*|/path…
05 фев '20 в 13:53
1 ответ

Как глобально установить класс реализации для типа данных атрибута модели?

Я хотел бы глобально установить класс реализации для определенных типов данных. Например, мы хотели бы перестать использовать аннотации во всех наших моделях. Вставил пример ниже. @Schema(implementation = OffsetDateTime.class) private Instant create…
07 фев '20 в 19:44