search

ePages-de / restdocs-api-spec

Adds API specification support to Spring REST Docs
MIT License
391 stars 103 forks source link

Support Spring REST Docs 3.0.0 (#211) #225

Closed tobiaskrauss closed 1 year ago

tobiaskrauss commented 1 year ago

According to spring-rest-docs 'requestParameters' are replaced by 'queryParameters' and 'formParameters'. If 'requestParameters' are used to document the API, this must be replaced by one of the new functions

Upgrades (needed to use spring-rest-docs 3.0.0):

Relates to #211

coveralls commented 1 year ago

Coverage Status

Coverage: 92.327% (-0.7%) from 92.999% when pulling 0cf4133e07ba5e3dc67de5fdc93b78523444c9cc on tobiaskrauss:upgrade-to-spring-restdocs-3.0.x into 9b847290cf1f3c412dc4bbcb52bc151ca1910227 on ePages-de:master.

tobiaskrauss commented 1 year ago

I just figured out that I missed the plugin part at least. I gonna change this PR to a draft again. Sorry for any inconvenience.

tobiaskrauss commented 1 year ago

Tested with upgraded sample app, which is not finally done but can be seen in this branch. The generated files and diffs for the sample app are attached. test-with-sample.zip

ozscheyge commented 1 year ago

Thanks a lot for this effort! Checking the diffs, there seems to be an issue with the HAL links in the example app, but that's likely local to the example app upgrade and not this PR.

tobiaskrauss commented 1 year ago

Thanks a lot for this effort! Checking the diffs, there seems to be an issue with the HAL links in the example app, but that's likely local to the example app upgrade and not this PR.

You are welcome. We are using this project for quite some time so thanks for maintaining. Regarding the sample: I gonna try to fix the HAL links and create the PR after this is released.