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

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 ответ

Open API Spec3 - Как отобразить раскрывающийся список или способ выбрать вход из нескольких входов?

Я работаю над Spring Boot & Open API Spec3 с помощью springdoc-openapi-ui. Как отобразить раскрывающийся список или способ выбрать вход из нескольких входов? Я прошел https://github.com/swagger-api/swagger-ui/issues/685, мне нужно что-то вроде э…
1 ответ

Как создать поле с нулевым значением типа, которое сопоставляется с объектом json с помощью springdoc-openapi / swagger?

Прежде всего, в следующем репозитории есть весь код (а также описание) для воспроизведения этой проблемы: https://github.com/elgleidson/swagger-problem У меня есть следующий JSON: { "nonNullableField": "not null", "nullableField": null, "nonNullable…
2 ответа

Добавление актуатора как сгруппированного OpenApi

Можем ли мы добавить конечные точки Actuator как groupedOpenApi, которые будут обрабатываться отдельно? пример: @bean public GroupedOpenApi actuatorApi() { return GroupedOpenApi.builder().setGroup("Actuator") .packagesToScan("org.springframework.boo…
1 ответ

Невозможно получить доступ к документации по spring-docs-open-ui swagger

Я новичок в Spring, пытаюсь настроить документацию Swagger для своего приложения Spring Boot. Я настроил свое приложение на основе документации, представленной здесь Я могу получить доступ к странице документации локально по этому URL-адресу http://…
1 ответ

Spring docs - Открытый API 3 - Как установить значения по умолчанию для тела?

Я использую Spring Boot + Spring Data Mongo + Spring REST + Spring HATEOAS для реализации конечных точек REST. Поскольку мы передаем более 5 параметров запроса (проприетарная настройка организации, предполагается, что она не передается), поэтому я р…
25 мар '20 в 20:00
3 ответа

SpringDoc - Как программно добавлять схемы

Я использую SpringDoc и пытаюсь программно добавить схему в OpenApi, но безуспешно. @Bean public OpenAPI customOpenAPI() { Schema mySchema = new Schema<Object>(); mySchema .type("object") .$ref("#/components/schemas/MySchema") .name("MySchema"…
11 май '20 в 15:00
1 ответ

Получение недопустимой попытки итерации не повторяемого экземпляра для SpringDoc Open API Swagger в IE

Я недавно изменил интерфейс чванства с Springfox к SpringDoc OpenApi. Swagger отлично работает на Chrome. но на Internet Explore Я получаю ошибки ниже. My IE version is 11
1 ответ

Springdoc-openapi - есть ли способ переопределить значение по умолчанию как нулевое или пустое в запросе POST?

Я использую Spring Boot и Open API 3. Через OAS2 Swagger, когда я делаю запрос POST, я вижу, что все поля String получают значение по умолчанию как Spring, и я не вижу способа удалить его ни через SpringDoc Open UI, ни через код. { "firstName": "str…
1 ответ

Как настроить и переопределить значения параметров из POJO?

Я работаю над примером Spring Boot v2.2.6.RELEASE и Open API Integration. В этом примере есть возможность поиска по 20 различным параметрам. Итак, этот класс POJO содержитCustomSearchDto эти 20 различных значений. В POJO я использовал orgName, но @p…
22 апр '20 в 18:25
1 ответ

Как я могу игнорировать PathVariable условно в пользовательском интерфейсе swagger с помощью springdoc openapi

Я перехожу с springfox 2.9.0 на springdoc-openapi-ui 1.2.33. У меня есть требование показать или скрыть PathVariable в пользовательском интерфейсе swagger в зависимости от условия. У меня есть два пути, как показано ниже Строка nameIdentifier = "{fi…
1 ответ

Как я могу задокументировать объекты, на которые я не владею?

Я возвращаю Page<SomeObject>В моем методе endpoints. В моем пользовательском интерфейсе OpenAPI, как я могу создать описание полей, которые поступают изorg.springframework.data.domain.Pageтип. Обычно я перехожу к объекту, который хочу задокуме…
2 ответа

Spring-Doc open api не работает с сервером облачной конфигурации Spring @EnableConfigServer

Я использую spring boot 2.3.2.RELEASE с участием spring-cloud-config-server 2.2.4.RELEASE. Я пытаюсь реализоватьspring-doc-openapi (1.4.3)в существующем проекте. Если я добавлю@EnableConfigServer в одном файле конфигурационного класса swagger-ui.htm…
2 ответа

Как сгенерировать RequestBody типа Map <String, Object> с помощью springdoc для swagger open api 3.0?

public Item addProperties( @Parameter(description = "identifier of the item") @PathVariable("id") String id, @Parameter(description = "map of property names and values ", content = @Content(schema = @Schema(type = "object", implementation = Map.clas…
1 ответ

Ошибка SpringDoc OpenAPI Swagger MergeAnnotations

Я пытаюсь настроить OpenAPI с помощью swagger для моего существующего загрузочного приложения, отличного от Spring. Spring v.5.1.8.RELEASESpringDoc v.1.4.6Spring-boot v.2.3.2.RELEASE Открытый документ и чванство с Spring MV Мое приложение не поддерж…
27 окт '20 в 19:58
1 ответ

SpringDoc app-doc.yaml не показывает документ чванства

У меня есть API с чванством. Пример конечной точки: @ApiOperation(value = "Returns a list of Pix transactions.",httpMethod = "POST",response = DResponse.class) @PostMapping("/transactions") public ResponseEntity<DResponse> getTransactions(@Req…
1 ответ

Как интегрировать Swagger с SpringDoc YAML?

Я использую Swagger для документирования своего проекта и хочу создать документ YAML из springdoc. Но когда я создаю эту документацию YAML, у YAML нет моих документов Swagger. Например. В моем проекте есть одна конечная точка: @ApiOperation(value = …
23 окт '20 в 19:12
1 ответ

Bean-компонент OpenApiCustomiser не содержит всей информации

С этим определением контроллера с тегом: @RestController @RequestMapping("/some_path") @Tag(name = "MyController") public class MyController { ... } При попытке настроить OpenApi я не могу получить значения тегов: @Bean public Op…
04 дек '20 в 16:56
1 ответ

springdoc-openapi-ui + swagger не понимает @PathVariable required = false flag

Я использую эту библиотеку для генерации документации: <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-ui</artifactId> <version>1.5.0</version> </dependency> У меня такой ко…