Описание тега spring-auto-restdocs

Вопросы с тегом
Spring Auto REST Docs - это расширение Spring REST Docs. Используйте этот тег для вопросов, относящихся к Spring Auto REST Docs, и тег spring-restdocs, чтобы задать общие вопросы о Spring REST Docs.
0 ответов

Spring-auto-restdocs имеет поля ответа, ссылающиеся на объекты, а не на их выравнивание

В настоящее время при использовании Spring Auto REST Docs для генерации полей ответов все объекты распределяются в ответ. Например, рассмотрим эти два класса: public class Foo { private Bar bar; /** Returns the bar. */ public Bar getBar() { return b…
09 июл '18 в 14:06
2 ответа

Автоматическая генерация документации REST API в RAML из контроллеров Spring MVC

Я новичок в Spring-Boot. Я хочу автоматически сгенерировать документацию по REST API в RAML с моих контроллеров Spring MVC. Есть что-нибудь для этого? или какое-либо руководство, что я мог бы использовать его для создания моего API для отдыха в RAML?
08 сен '18 в 16:02
0 ответов

Не могу связать мои javadocs с весенними документами по авто отдыху

Я не понимаю, как вы используете JavaDocs, с Spring Auto Rest Docs. Я могу сгенерировать свои java-документы локально с помощью опции STS, UI. Тем не менее, я не уверен, как генерировать документы Java, используя Spring Auto Rest Docs. Я пытался нап…
02 апр '18 в 02:28
1 ответ

Можно ли использовать spring-auto-restdocs с Swagger/SpringFox?

Можно ли использовать spring-auto-restdocs с Swagger/SpringFox, swagger2markup? Я хотел бы: - Использовать Swagger / SpringFox для предоставления тестовой области, НО тогда я хочу, чтобы примеры в этом пользовательском интерфейсе были похожи на то, …
28 май '18 в 17:02
1 ответ

Автоматическое отображение списка перечислений в документах по автоматическому отдыху не объясняет

Я сгенерировал документ, используя документы Spring Auto Rest. При этом используются библиотеки capital.scalable в сочетании с документами Java и документами Spring Rest. Моя проблема связана со списком перечислений при описании полей запроса. Тип с…
30 ноя '17 в 13:00
0 ответов

maven-javadoc-plugin: как сказать Maven, чтобы он загружал javadocs только из указанных пакетов?

Когда я использую флаги includeDependencySources а также dependencySourceInclude (см. руководство) maven-javadoc-plugin для включения в мой проект javadocs из определенного пакета, например: <configuration> <includeDependencySources>true…
25 июл '18 в 08:32
0 ответов

Spring RestDocs генерирует страницы для внешнего интерфейса

Мое весеннее приложение RestApi успешно генерирует фрагменты с помощью RestDoc, но я не могу использовать фрагменты для автоматического создания страниц для запуска на веб-интерфейсе. http://localhost/docs возвращает 404, и html не генерируется в st…
24 мар '18 в 16:42
2 ответа

Описание поля Spring-restdocs из аннотаций

Можно ли использовать аннотации (на уровне полей) для описания полей? Я знаю, что могу использовать description метод для этого .andDo(document("index", responseFields( fieldWithPath("contact").description("The user's contact details"), но я бы пред…
07 дек '16 в 14:41
1 ответ

Spring Auto REST Docs - не работает должным образом

Я использую Java 8, Spring Boot 2.0, JUnit4. Я пытаюсь сделать правильную документацию с Spring Auto REST Docs. Вот мой ДТО: @Data @NoArgsConstructor public class ESLogRequestDTO { /** * Дата начала поиска */ @JsonFormat(shape = JsonFormat.Shape.STR…
11 июл '18 в 12:20
1 ответ

Как автоматически генерировать поля ответа, которые не имеют POJO

У нас есть сервис, который просто возвращает документ json по запросу GET. Поскольку у нас нет POJO для ответа "модель", похоже, мы не сможем использовать генерацию полей автоответа "доброта". Один из вариантов для нас - создать Pojos (довольно боль…
01 янв '18 в 15:58
1 ответ

Spring Auto REST Документы + Spring Data REST? HATEOAS?

Мне очень нравится идея использования комментариев Javadoc для автоматической генерации документов REST! Spring Data REST автоматически генерирует огромные части нашего REST API (добавляя @RepositoryRestResource в репозитории). Было бы здорово, если…
12 фев '18 в 15:23
0 ответов

Manually configure Jackson Module for Spring WebTestClient

Предпосылки Весенний ботинок: 2.0.3.RELEASE Весенние ОТДЫХА Документы: 2.0.1.RELEASE Spring Auto REST Docs: 2.0.2-SNAPSHOT - Какая локальная сборка текущего мастера. GeoJsonModule настраивается в основном приложении: import org.springframework.data…
25 июл '18 в 07:20
1 ответ

Не генерирует заглушку с помощью WireMockRestDocs и SpringAutoRestDocs

Я использую Spring Auto REST Docs - это расширение Spring REST Docs для генерации документации API, и я делаю настройку MockMvc, как в документации. Кроме того, в то же время я хочу создать заглушку WireMock с " http://cloud.spring.io/spring-cloud-c…
07 сен '17 в 07:34
1 ответ

Как и где использовать failOnUndocumentedParams в Spring Auto REST Docs?

Я работаю с Spring Auto REST Docs и хочу знать, как использовать failOnUndocumentedParams и как его использовать. Я хочу, чтобы документация не генерировалась, если я пропустил поле из POJO. Я считаю, что с помощью failOnUndocumentedParams мое решен…
26 мар '18 в 01:34
1 ответ

Не найдено описание для классов с пользовательским Jackson ObjectMapper

Я столкнулся с проблемой с Spring AutoRest Docs. Кажется, проистекает из этого кода .alwaysDo<DefaultMockMvcBuilder>(JacksonResultHandlers.prepareJackson(objectMapper)) Полная конфигурация: mockMvc = MockMvcBuilders .webAppContextSetup(webAppl…
13 июн '19 в 03:08
1 ответ

Задача jsonDoclet: не удалось создать Javadoc

Я пытаюсь настроить spring-auto-restdocs в моем проекте, который использует JDK 11, Gradle 5, JUnit5 и Spring Webflux с весенней загрузкой 2.1.1. Я следовал нормальному руководству по установке spring-restdocs здесь: https://docs.spring.io/spring-re…
06 авг '19 в 10:21
1 ответ

Spring REST Docs дублирует параметр запроса без значения в фрагментах запроса curl и HTTP

Я использую Spring REST Docs (2.0.3.RELEASE) и Spring Auto Restdocs (2.0.6) для документирования REST API. Когда запрос содержит параметр запроса, которому не присвоено значение (пустая строка), фрагменты, созданныеCliDocumentation.curlRequest() а т…
02 окт '19 в 20:58
1 ответ

Spring Auto Rest Docs документирует все подтипы Json

У меня есть услуга Rest с двумя операциями / балансом и / транзакциями для получения баланса и транзакций клиента. Тип возврата этой операции - BalanceResponse и TransactionResponse, и оба эти типа являются расширением от Response. при документирова…
12 май '20 в 20:03
0 ответов

include:: не работает для загрузки файла .adoc из любых внешних ссылок

Я использую Spring rest doc, а для основного index.adoc мне нужно включить какой-то другой внешний файл.adoc в качестве описания, но пока я помещаю его в файл index.adoc, он выглядит как внешняя ссылка, а не загружает содержимое этого конкретного ad…
28 июл '20 в 11:59
2 ответа

Настройте заголовок раздела в Spring Auto Rest Docs

Я хочу изменить заголовок раздела в auto-section.adoc[]файл, созданный Spring Auto Rest Docs. Spring Auto Rest Docs разрешает заголовок раздела, используя@titleТег Javadoc в методе (если есть) или из имени метода (как указано в документации), но я н…
10 дек '19 в 10:07