I'm adopting Spring Rest Docs and the test successfully created *.adoc files. I made api-guide.doc file in src/docs/asciidoc directory to create html, but when I run asciidoc as a gradle task, it p...

I followed the getting started guide for Spring Rest Doc word by word, but I cannot get any html out of the generated snippets. The snippets are generated fine in the directory I configure (build/...

Spring REST Docs was released recently and the documentation says: This approach frees you from the limitations imposed by tools like Swagger So, I wanted to ask when Spring REST Docs is prefe...

My app is using spring-data-rest and spring-restdocs. My setup is really standard; copied from the docs almost entirely, but I've included the samples below in case I'm missing something. When my m...

I write my API documentation with Spring REST Docs. Code example: @Override public void getById(String urlTemplate, PathParametersSnippet pathParametersSnippet, Object... urlVariables) throws Exc...

I try to set the context path for spring rest mocks using the following code snippet: private MockMvc mockMvc; @Before public void setUp() { this.mockMvc = MockMvcBuilders.webAppContextSetup(this...

I am trying to integrate Spring REST docs with rest assured with Grails 3.1.4 application. I am using JSON Views. Complete code is at https://github.com/rohitpal99/rest-docs In NoteController whe...

I am using Spring REST Docs to document a REST API. I'm trying to document the following API operations: GET /subsystems GET /subsystems/some_name For example, a call to GET /subsystems/samba re...

Let's say we have the following API: @RestController public class PersonController { @GetMapping("/api/person") public List<Person> findPeople() { return Arrays.asList(new Person("Doe",...

I migrated my Spring tests to JUnit 5, and they work fine. However, I don't know how to migrate @Rule public JUnitRestDocumentation restDocumentation = .... Any hint is appreciated.

Spring REST Docs produces a curl snippet which is very convenient when testing. It is equivalent to the MockMvc call as said in its docs but it would be good if its host part can be replaced with a...

I've searched, but I can't find a way to hide the section title on the main page, and to only display in the Table of Contents (:toc:). As seen from this screenshot, Home and Test are external link...

Hi i am trying to search data in elastic search using spring RestTemplate. ElasticSearch have user name and password and i want to search via json. I wrote code for this but i am not getting any r...

I am building an API and documenting it using Spring Rest Docs (1.1.1.RELEASE) and there is an api which returns an image as byte array. I need to describe the response type in REST docs. I am not...

I'm using Spring Rest Docs to generate documentation. I would like to do something like Bootstrap's Togglable tabs. Spring documentation uses togglable tabs, but I don't know how to do it. Here is...

When using pathParameters to document the URI path parameters like below @Test public void documentGetRouteById() throws Exception { this.mockMvc.perform(get("/route/{id}", "FooBar")).andExpect(s...