-
Notifications
You must be signed in to change notification settings - Fork 738
Spring REST Docs 3.0 Release Notes
Support for documenting form parameters has been added. Please refer to the reference documentation for further details. This new support partially replaces the support for documenting request parameters which mixed query and form parameters together.
Support for documenting query parameters has been added. Please refer to the reference documentation for further details. This new support partially replaces the support for documenting request parameters which mixed query and form parameters together.
Support for documenting request and response cookies has been added. Please refer to the reference documentation for further details.
The language is now specified automatically in request and response body snippets.
It is determined using the Content-Type of the request or response.
For example,
a response whose Content-Type is application/json will have the language of its body snippet set to json.
Support for documenting request parameters has been removed. Request parameters are a server-side construct of the Servlet API that mix form and query parameters together. To provide accurate, client-focussed documentation, form and query parameters should be documented separately.
Support for pre-processing a request to modify its parameters has been removed. Where parameter modification is required, the request’s URI should be updated to modify its query parameters or its form URL encoded body should be updated to modify its form parameters.