spring-restdocs

spring-restdocs copied to clipboard

Provide a Gradle plugin that applies REST Docs' configuration conventions

1

When you use REST Docs with Gradle there are a few things that need to be configured: 1. `snippetsDir` extra property 2. Additional output directory on the `test` task that...

wilkinsona

There seems to be an assumed dependency on Xalan in org.springframework.restdocs.payload.XmlContentHandler of spring-restdocs-core-2.0.3.RELEASE.jar. Line 180 has this: ``` transformerFactory.setAttribute("indent-number", 4) ``` Saxon uses "indent-spaces" attribute for the same thing, so...

willredclef

Request body is empty when using MockMvc, application/x-www-form-urlencoded and param

6

Reproducible repository at: https://github.com/unlimitedsola/restdocs-empty-body-issue The generated asciidoc doesn't contain any request body/parameter

unlimitedsola

Support for passing custom values/services into Snippet classes

3

In our auto-documentation extension https://github.com/ScaCap/spring-auto-restdocs we are trying to automate documentation as much as possible by introspecting code. For this we created extensions of Snippets which are dependent on some...

jmisur

Add support for replacing binary multipart data with placeholder content

2

You can see in [this Stack Overflow question](http://stackoverflow.com/q/37860530/2587435), that when posting Multipart data, often there is binary data, which causes the resulting snippet to be a large amount of garbled...

psamsotha

Produce URI Snippet

5

It would be useful to be able to document a resources URI as part of documenting a given resource, this could use the custom scheme, server and port as configured...

hughwphamill

Allow the type of an array's scalar elements to be documented and enforced

2

Not sure if this is the right place to ask this question but maybe it directly translates to a feature request. Let our payload be as follows: ```json { "data":...

Fleshgrinder

Provide a snippet for documenting request and response structure

9

With complex, heavily nested payloads some people have found the table of fields that's currently produced by the request and response fields snippets a little difficult to use when trying...

wilkinsona

Provide support for automatic documentation of request and response structure using JSON schema

3

Spring Data REST can provide a JSON schema for each repository. Explore the possibility of using the returned schema to automatically generate documentation of request and response structure.

wilkinsona

Supporting postman collections

10

What do you guys think about supporting postman collections? It should be possible to integrate them in a similar manner as the curl documentation, although it could be tricky because...

thomaseizinger