spring-restdocs

spring-restdocs copied to clipboard

Document that the query string should be provided in the URL or by using queryParam when using MockMvc

1

Greetings! Query parameters are ignored when using param builder: ``` mockMvc.perform( delete("/v1/event/configs/delete") .param("eventName", "CART2") .param("name", "available") ) .andExpect(status().isOk) .andDo(document("delete-event-config")) ``` However, this one works: ``` mockMvc.perform( delete("/v1/event/configs/delete?eventName=CART2&name=available")) .andExpect(status().isOk) .andDo(document("delete-event-config")) ```...

nick-shevchenko

Add support for MockMvcWebTestClient

1

wilkinsona

Add support for Bean Validation's constraint groups

2

The docs gives an example of documenting constraints: ```java public void example() { ConstraintDescriptions userConstraints = new ConstraintDescriptions(UserInput.class); List descriptions = userConstraints.descriptionsForProperty("name"); } static class UserInput { @NotNull @Size(min =...

AugustoRavazoli

Replace factory with builder when creating operation requests/responses

1

Both the `OperationRequestFactory` and `OperationResponseFactory` leads to unnecessary code in custom pre-processors: ```java new OperationRequestFactory().create( uri, request.getMethod(), request.getContent(), headers, request.getParts(), cookies ); ``` A possible way to simplify the request...

AugustoRavazoli

In working on #626, it has become apparent that the lack of distinction that is made between `a.[]` and `a` is problematic. It's a subtle difference, but the former should...

wilkinsona

Taken from [this question]() on Stack Overflow, consider the following JSON payload: ```javascript { "count": 2, "items": [ { "k1": "v1", "k2": [] }, { "k1": "v2", "k2": [ {...

wilkinsona

Add ability to document an object root, just like it is possible to document an array

1

Hi, We're using this framework to document a REST API. The API has several endpoints that return a user object like `{"name": "Danny Default", "id": 123}`. To create a user:...

sherzinger

When REST Docs began there was no term in the Spring portfolio describing a request being sent to an endpoint and a response being received so "operation" was used. Since...

wilkinsona

Improve beneathPath to work with multiple nested arrays

1

In `beneathPath()`, paths with an array work now, thanks to #473 and 9e1ba8a. But I'm still having a problem with arrays when there are two levels of arrays in the...

Jeff-Walker

Create Kotlin DSL for Spring RestDocs

29

I've been working on a Kotlin DSL for restDocs and have [converted a number of samples](https://github.com/checketts/spring-restdocs/blob/dsl-poc/samples/rest-notes-spring-hateoas/src/test/java/com/example/notes/ApiDocumentation.kt#L224) to demonstrate it. I would love to contribute the DSL into the spring-restdocs project....

checketts