spring-restdocs

spring-restdocs copied to clipboard

Support multiple types on a field descriptor and assert that actual type matches one of them

7

The following code produce a nice output in the type column, but It does not perform the assertion: ``` fieldWithPath("uid").type(Arrays.asList(JsonFieldType.STRING, JsonFieldType.NULL)); ``` Is there a better way to do it?...

victorherraiz

Provide a fluent API for snippet configuration

1

Since REST assured is based on a fluent API it would be awesome if Spring REST docs could provide a fluent (builder) API in addition to the varargs based approach....

rhuss

Provide an option to switch off the curl snippet's use of -i

4

**Situation** In case that a REST Endpoint provide a binary content ex. `application/zip`. The generated curl request snippet should not contains the curl options `-i`. Because it include HTTP headers...

ghost

Provide an option for a field to be hidden from the documentation while still being validated

1

Hi, Let's say we have a field description like this: ``` fieldWithPath("foo") .type(JsonFieldType.STRING) .description("some description") ``` If the returned value is `"foo": null`, then an exception is being thrown because...

sherzinger

Add support of collections inner constraints. Example: `@Valid private List someUsefulInformationList;` Example of expected snippet:  PS: StackOverflow [question](https://stackoverflow.com/questions/67104197/how-i-can-document-inner-collection-constraints-in-spring-auto-restdocs)

GrinRus

Document how to use Spring REST Docs with the MockMVC Kotlin DSL

6

Was trying to implement RestDocs MockMvc in our Kotlin project However noticed that when using the MockMvc Kotlin DSL snippets were not generated e.g. ``` fun shouldReturnDefaultMessageKotlinDSL() { mockMvc.get("/hello") .andExpect...

ghost

Native support for Server-Sent Events and Streaming API endpoints

4

Maybe Spring REST Docs could support natively Server-Sent Events endpoints, as supported in Spring Framework 4.2+ thanks to [`SseEmitter`](http://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/servlet/mvc/method/annotation/SseEmitter.html) type, and global Streaming API support based on [`ResponseBodyEmitter`](http://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/servlet/mvc/method/annotation/ResponseBodyEmitter.html) type. I...

sdeleuze

Provide better diagnostics when a descriptor is missing a property required by the snippet template

4

Background: I removed some method calls to "description()" to better debug my Rest tests, big mistake. Now I understand the exception, but I needed to debug it, to understand that...

FloHin

Support array indices in JSON field paths

2

Hi, when using a `PayloadSubsectionExtractor` (e.g. `FieldPathPayloadSubsectionExtractor`) to extract a subsection of a JSON payload, array indices are ignored. I would assume that when a path is used like `Outer[].Nested[0].Attribute`...

mariusoe

Provide more control over quotes used in curl and HTTPie request snippets

1

Currently Spring REST Docs generates snippets using single quotes around header values: `$ curl 'https://some.url.com/teams' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer $TOKEN' -d '{...

ke4