spring-restdocs
spring-restdocs copied to clipboard
spring-projects
Test-driven documentation for RESTful services
When documenting some endpoint which returns protobuf format, I'd find it useful to be able to document the response headers without the body. Currently this is what I get: ```...
Controllers using MessageMapping(s) instead of rest endpoint have very similar requirements for documentation. Could spring-restdocs be used for those controllers too?
When support for documenting HTTP headers was added a decision was made that, unlike the other snippets, a failure would not occur if a header wasn't documented. This was to...
My spring project works fine, but tests crashes when I add spring-restdocs to gradle dependencies. Just that (no configuration chages, no test code changes) brakes my project. The problem is...
It feels like a magic number to use `80` or `443` in the `UriConfigurer#withPort` method to suppress the port output given the right scheme. There should be a method to...
# Overview Starting discussion on [Gitter](https://gitter.im/spring-projects/spring-restdocs?at=57442bd8fce033da4bef6d42) Would be great to be able to externalize documentation message outside of testing class like `.properties` or `.yml` files. Moreover external resources could be...
The URI specification RFC 3986 defines the possibility of including name-value pairs within path segments. Spring MVC has support for this for a long while. How do you recommend documenting...
See http://stackoverflow.com/questions/37357308/how-do-you-state-no-response-fields-with-spring-rest-docs
At the moment you can document a link or field that isn't there by marking it as optional. It works, but it can lead to inaccuracies in the documentation. An...
Rather than requiring the curie name to be included when documenting the link (for example `foo:bar`), it should be possible to just use `bar`.
Metadata
Owner
Metadata
Test-driven documentation for RESTful services