4 Commits

Author	SHA1	Message	Date
Andy Wilkinson	0c8a71370b	Rework the API to improve readability and extensibility ... This commit updates the API to improve its extensibility and readability. SnippetWritingResultHandler has been replaced with a more general purpose Snippet interface. Snippets are now provided to the main document method using varargs rather than the various with… methods that were previously used. As a result a custom Snippet implementation can now be used in exactly the same way as any of the built-in snippets: this.mockMvc.perform(get("/")) .andExpect(status().isOk()) .andDo(document("index-example", links( linkWithRel("notes").description("…"), linkWithRel("tags").description("…")), responseFields( fieldWithPath("_links").description("…")), yourCustomSnippet())); Control of the snippets that are generated by default is now available via RestDocumentationConfigurer: this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context) .apply(documentationConfiguration().snippets() .withDefaults(curlRequest(), yourCustomSnippet())) .build(); See gh-73	2015-08-10 12:06:32 +01:00
Andy Wilkinson	8e2fc7f45d	Provide support for documenting path parameters ... This commit adds support for documenting a request's path parameters. For example: mockMvc.perform( get("/locations/{latitude}/{longitude}", 51.5072, 0.1275)) .andExpect(status().isOk()) .andDo(document("locations").withPathParameters( parameterWithName("latitude") .description("The location's latitude"), parameterWithName("longitude") .description("The location's longitude") )); Closes gh-86	2015-07-29 14:50:49 +01:00
Andy Wilkinson	833f0eabb8	Polishing: replace spaces with tabs in doc examples ... See gh-37	2015-06-16 17:21:43 +01:00
Andy Wilkinson	8307fb5428	Add reference documentation and create docs zip ... Add reference documentation for the project and add a docs artifact that contains both the reference documentation and the javadoc. See gh-37	2015-06-16 17:14:31 +01:00