Spring REST Docs takes a test-driven approach to documenting RESTful APIs. It uses Spring MVC Test, Spring WebFlux’s WebTestClient or REST Assured to generate accurate, tested documentation snippets that can then be included in documentation written in Asciidoctor or Markdown. Use this tag for questions about Spring REST Docs and its interaction with one of the test frameworks and markup languages.
Questions tagged [spring-restdocs]
274 questions
0
votes
1 answer
spring-restdocs is not recognizing apply()
I am trying to generate a Rest API documentation based on spring-restdocs
In following code I am getting a compile time error at apply()
The method apply(RestDocumentationMockMvcConfigurer) is undefined for the type…
Vijay Kumar Rajput
- 1,071
- 1
- 10
- 30
0
votes
2 answers
Documenting JSON in URL not possible
In my Rest API it should be possible to retrieve data which is inside a bounding box. Because the bounding box has four coordinates I want to design the GET requests in such way, that they accept the bounding box as JSON. Therefore I need to be able…
gillesB
- 1,061
- 1
- 14
- 30
-1
votes
1 answer
asciidoc section titles not working
I have the following asciidoc where I would like to have multiple section titles.
= REST API
== Token
Tokens are used for making authenticated requests to the API.
=== Getting a token
This is how you get a token
But it ends up looking something…
secondbreakfast
- 4,194
- 5
- 47
- 101
-2
votes
1 answer
Caused by: java.lang.illegalArgumentException
Trying to use Junit tests to generate documentation using Spring Rest Docs, but I'm getting these errors which I can't identify where it's coming from. I'm a junior developer so inexperience may be part of it.
java.lang.IllegalStateException: Failed…
Sathle
- 1
- 1
- 2