Spring Auto REST Docs is an extension of Spring REST Docs. Use this tag for questions that are specific to Spring Auto REST Docs and the tag spring-restdocs to ask general questions about Spring REST Docs.
Questions tagged [spring-auto-restdocs]
21 questions
5
votes
1 answer
jsonDoclet task: Javadoc generation failed
I am trying to setup spring-auto-restdocs in my project, which uses JDK 11, Gradle 5, JUnit5 and Spring Webflux with spring boot 2.1.1.
I've followed the normal spring-restdocs setup guide here:…
logi0517
- 813
- 1
- 13
- 32
4
votes
2 answers
Auto generate REST api documentation into RAML from Spring MVC controllers
I am new to Spring-Boot. I want to auto generate my REST api documentation into RAML from my Spring MVC controllers. Is there anything to do that? or any guide that I could use it for generating my rest api into RAML?
user6941415
3
votes
0 answers
Spring-auto-restdocs have response fields link to objects instead of flattening them
Currently, when using Spring Auto REST Docs to generate response fields, all objects are flattened out into the response. For example consider these two classes:
public class Foo {
private Bar bar;
/** Returns the bar. */
public Bar…
Bram
- 988
- 7
- 10
3
votes
2 answers
Spring-restdocs field description from annotations
Is it possible to use annotations (at field-level) to provide description for fields?
I know I can use description method for that
.andDo(document("index", responseFields(
fieldWithPath("contact").description("The user's contact…
Bartosz Bilicki
- 12,599
- 13
- 71
- 113
2
votes
1 answer
Auto display of list of enums in spring auto rest docs isn't explanatory
I've generated a document using spring auto rest docs. This uses capital.scalable libraries combined with java docs and spring rest docs.
My issue is with the List of enums while describing the request fields.
Type column generates a value as…
Ankit Bhatnagar
- 745
- 5
- 16
1
vote
2 answers
Customize Section title in Spring Auto Rest Docs
I want to customize Section "title" in auto-section.adoc[] file generated by Spring Auto Rest Docs. Spring Auto Rest Docs resolves section title using @title Javadoc tag on the method(if present) or from the method name (as mentioned in docs), but i…
HelloWorld
- 123
- 1
- 12
1
vote
1 answer
Is it possible to use spring-auto-restdocs with Swagger/SpringFox?
Is it possible to use spring-auto-restdocs with Swagger/SpringFox, swagger2markup?
I'd like to:
- Use Swagger/SpringFox to provide the test area
BUT then I want the examples in that UI to be similar to what
- spring-restdoc does to provide the…
Melissa
- 812
- 2
- 10
- 24
1
vote
1 answer
Spring Auto REST Docs + Spring Data REST? HATEOAS?
I really like the idea of using Javadoc comments for auto-generating REST Docs!
Huge parts of our REST API are automatically generated by Spring Data REST (by adding @RepositoryRestResource to Repositories). It would be great if REST Docs could also…
Thomas B.
- 11
- 1
1
vote
1 answer
Doesn't generate stub using WireMockRestDocs and SpringAutoRestDocs
I'm using Spring Auto REST Docs is an extension to Spring REST Docs to generate API documentation and I'm doing the set up the MockMvc as in the documentation.
As well, the same time I want generate the WireMock Stub with…
Diego Fernández
- 11
- 1
0
votes
1 answer
How i can document inner collection constraints in spring auto restdocs
I'm trying to document inner constraint for Collections (NotBlank and Size) like:
@Valid
private List<@NotBlank @Size(min = 1, max = 100) String> someAnotherUsefulInformationList;
Can I do it with built-in functionality?
PS: I found a place…
Grigorii Riabov
- 185
- 2
- 8
0
votes
1 answer
Spring REST Docs + RequestBody + Prevent deep-level documentation of fields
i have problems with Spring REST Docs and preventing deep-level documentation of fields within a request body:
@Transactional
@RequestMapping(path = "/edit", method = RequestMethod.POST)
public ResponseEntity edit(
…
alex_steward
- 5
- 2
0
votes
0 answers
Spring rest docs request url shows value for path parameter instead of the parameter name
I use spring rest docs to document my api.
Now I want to document my document my path in the form of
.../accounts/{userId}
but I get
.../accounts/123
The test part look as follows:
…
FishingIsLife
- 1,972
- 3
- 28
- 51
0
votes
1 answer
Auto Section title level in Spring Auto Rest Docs
This is my first question on StackOverflow.
I am using Java 11, Spring Boot 2.4.0, JUnit 5, Auto Rest Docs 2.0.9.
I am getting the following warning when I am generating the document:
asciidoctor: WARNING:…
Kashan Nadeem
- 113
- 7
0
votes
1 answer
Spring Auto Rest Docs documents all Json subTypes
I have a Rest service with two operations /balance and /transactions to get the balance and transactions of a customer.
The return type of this operations is BalanceResponse and TransactionResponse and both these type is extended from Response…
Raj
- 211
- 2
- 3
0
votes
1 answer
Spring REST Docs duplicates query parameter without value in curl and HTTP request snippets
I'm using Spring REST Docs (2.0.3.RELEASE) and Spring Auto Restdocs (2.0.6) to document a REST API.
When the request contains a query parameter that has no assigned value (empty string) the snippets produced by CliDocumentation.curlRequest() and…
Bruno Silva
- 11
- 3