Home

Welcome to the RESTDocsEXT Jersey wiki!

Spring RESTDocsEXT Jersey is an extension of the Spring REST Docs, that allows for creating REST API documentation snippets, in a Test Driven way, using the Jersey/JAX-RS Client. Currently, the officially support client/testing frameworks to use Spring REST Docs are Spring MockMvc and RestAssured. Though the RestAssured support may also be used a client to test Jersey applications, this project is aimed at users who would use Jersey client and would like to stick to what they are used to. Aside from directly using the client, this project also ties in seamlessly when using Jersey Test Framework.

This wiki will into details about this implementation in particular, but will not go in depth on how to use the core Spring REST Docs APIs. There is not really anything special about how the core APIs are used in connection to this project. Therefore, for more information on how to use the core APIs, have a look at the reference documentation for Spring REST Docs.

If you have any issues or feature requests, please feel free to submit one.