Add support for documenting request and response cookies

[clydebarrow]

Addresses enhancement request #306 and issue #593.

Documentation of cookies in requests and responses follows the same pattern as that already used for headers.

[pivotal-issuemaster]

@clydebarrow Please sign the Contributor License Agreement!

Click here to manually synchronize the status of this Pull Request.

See the FAQ for frequently asked questions.

[pivotal-issuemaster]

@clydebarrow Thank you for signing the Contributor License Agreement!

[clydebarrow]

CheckStyle fails on my build with errors like this from test code:

RequestCookiesSnippetFailureTests.java:32: Using a static member import should be avoided - org.springframework.restdocs.cookies.CookieDocumentation.cookieWithName. [AvoidStaticImport]

But similar usage of static imports is already present, and passes checkStyle, in existing test code. I have absolutely no idea how to deal with that - is there some hidden config for checkStyle? I could only find an xml file that references an external project.

[wilkinsona]

This looks great on first look, @clydebarrow. Thanks very much, particularly for adding plenty of tests and updating the docs too.

The CheckStyle config comes from Spring Java Format. Please don't worry about it for now. I can look at allowing some new static imports there in due course.

We generally try to keep diffs as clean as possible by only changing what's needed to fix an issue or implement a new feature. To that end, can you please revert the changes to build.gradle and RequestDocumentation.

Where you've added a whole new class, can you please add @since 2.1 to its javadoc. Similarly, where you've added a new method to an existing class, can you please add @since 2.1 to the method's javadoc.

[clydebarrow]

@wilkinsona The changes to build.gradle were to allow the build to complete without error. I have raised an issue #593 to clarify this, and determined that only one of the changes to build.gradle was needed. I will revert the other.

[clydebarrow]

repo.spring.io appears to be down right now.

[Fameing]

Are there any movements in this feature? This functionality is sorely lacking.

[wilkinsona]

No, sorry. There's nothing beyond what you can see here. The plan is to include the changes proposed here in Spring REST Docs 2.1, but there's no date for that release at this time.

[wilkinsona]

Thanks again for the contribution, @clydebarrow, and for your patience until we got this merged.