Java MockMvcRestDocumentation类代码示例

import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation; //导入依赖的package包/类
public static RestDocumentationResultHandler document(String identifier,
                                                      String description,
                                                      boolean privateResource,
                                                      OperationRequestPreprocessor requestPreprocessor,
                                                      OperationResponsePreprocessor responsePreprocessor,
                                                      Function<List<Snippet>, List<Snippet>> snippetFilter,
                                                      Snippet... snippets) {

    Snippet[] enhancedSnippets = enhanceSnippetsWithRaml(description, privateResource, snippetFilter, snippets);

    if (requestPreprocessor != null && responsePreprocessor != null) {
        return MockMvcRestDocumentation.document(identifier, requestPreprocessor, responsePreprocessor, enhancedSnippets);
    } else if (requestPreprocessor != null) {
        return MockMvcRestDocumentation.document(identifier, requestPreprocessor, enhancedSnippets);
    } else if (responsePreprocessor != null) {
        return MockMvcRestDocumentation.document(identifier, responsePreprocessor, enhancedSnippets);
    }

    return MockMvcRestDocumentation.document(identifier, enhancedSnippets);
}
 

import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation; //导入依赖的package包/类
@Test
public void should_grant_a_beer_when_person_is_old_enough() throws Exception {
	PersonToCheck personToCheck = new PersonToCheck(34);
	//remove::start[]
	mockMvc.perform(MockMvcRequestBuilders.post("/check")
			.contentType(MediaType.APPLICATION_JSON)
			.content(json.write(personToCheck).getJson()))
			.andExpect(jsonPath("$.status").value("OK"))
			.andDo(WireMockRestDocs.verify()
					.jsonPath("$[?(@.age >= 20)]")
					.contentType(MediaType.valueOf("application/json"))
					.stub("shouldGrantABeerIfOldEnough"))
			.andDo(MockMvcRestDocumentation.document("shouldGrantABeerIfOldEnough",
					SpringCloudContractRestDocs.dslContract()));
	//remove::end[]
}
 

import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation; //导入依赖的package包/类
@Test
public void should_reject_a_beer_when_person_is_too_young() throws Exception {
	PersonToCheck personToCheck = new PersonToCheck(10);
	//remove::start[]
	mockMvc.perform(MockMvcRequestBuilders.post("/check")
			.contentType(MediaType.APPLICATION_JSON)
			.content(json.write(personToCheck).getJson()))
			.andExpect(jsonPath("$.status").value("NOT_OK"))
			.andDo(WireMockRestDocs.verify()
					.jsonPath("$[?(@.age < 20)]")
					.contentType(MediaType.valueOf("application/json"))
					.stub("shouldRejectABeerIfTooYoung"))
			.andDo(MockMvcRestDocumentation.document("shouldRejectABeerIfTooYoung",
					SpringCloudContractRestDocs.dslContract()));
	//remove::end[]
}
 

import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation; //导入依赖的package包/类
@Test
public void getCustomerByIdShouldReturnCustomer() throws Exception {

    Mockito
            .when(this.customerRepository.findOne(1L))
            .thenReturn(c1);

    mockMvc.perform(MockMvcRequestBuilders.get("/customers/1"))
            .andExpect(MockMvcResultMatchers.status().is2xxSuccessful())
            .andExpect(MockMvcResultMatchers.content().contentType(MediaType.APPLICATION_JSON_UTF8_VALUE))
            .andExpect(MockMvcResultMatchers.jsonPath("@.id").value(1L))
            .andDo(MockMvcRestDocumentation.document("customerById"));
}
 

import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation; //导入依赖的package包/类
@Test
public void customersShouldReturnAllCustomers() throws Exception {

    Mockito.when(this.customerRepository.findAll()).thenReturn(Arrays.asList(
            new Customer(1L, "first", "last", "[email protected]"),
            new Customer(2L, "first", "last", "[email protected]")));

    this.mockMvc.perform(MockMvcRequestBuilders.get("/customers"))
            .andExpect(MockMvcResultMatchers.status().is2xxSuccessful())
            .andExpect(MockMvcResultMatchers.content().contentType(MediaType.APPLICATION_JSON_UTF8_VALUE))
            .andExpect(MockMvcResultMatchers.jsonPath("@.[0].id").value(1L))
            .andExpect(MockMvcResultMatchers.jsonPath("@.[0].firstName").value("first"))
            .andExpect(MockMvcResultMatchers.jsonPath("@.[1].id").value(2L))
            .andDo(MockMvcRestDocumentation.document("customers"));
}
 

import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation; //导入依赖的package包/类
@Before
public void setup() {
  MockitoAnnotations.initMocks(this);

  mvc =
      MockMvcBuilders.webAppContextSetup(applicationContext)
          .apply(MockMvcRestDocumentation.documentationConfiguration(this.restDocumentation))
          .build();
}
 

import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation; //导入依赖的package包/类
@Bean
@ConditionalOnMissingBean(MockMvcRestDocumentationConfigurer.class)
public MockMvcRestDocumentationConfigurer restDocsMockMvcConfigurer(
		ObjectProvider<RestDocsMockMvcConfigurationCustomizer> configurationCustomizerProvider,
		RestDocumentationContextProvider contextProvider) {
	MockMvcRestDocumentationConfigurer configurer = MockMvcRestDocumentation
			.documentationConfiguration(contextProvider);
	RestDocsMockMvcConfigurationCustomizer configurationCustomizer = configurationCustomizerProvider
			.getIfAvailable();
	if (configurationCustomizer != null) {
		configurationCustomizer.customize(configurer);
	}
	return configurer;
}
 

import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation; //导入依赖的package包/类
@Before
public void before() {
  this.mockMvc = MockMvcBuilders
      .webAppContextSetup(this.wac)
      .apply(MockMvcRestDocumentation.documentationConfiguration(this.restDocumentation))
      .build();
}
 

import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation; //导入依赖的package包/类
@Bean
public RestDocumentationResultHandler restDocumentation() {
    return MockMvcRestDocumentation.document("{method-name}/{step}",
                                             preprocessRequest(prettyPrint()),
                                             preprocessResponse(prettyPrint()));
}
 

import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation; //导入依赖的package包/类
/**
 * Wraps the static document() method of RestDocs and configures it to pretty print request and
 * response JSON structures.
 */
protected RestDocumentationResultHandler document(String identifier, Snippet... snippets) {
  return MockMvcRestDocumentation.document(
      identifier, preprocessRequest(prettyPrint()), preprocessResponse(prettyPrint()), snippets);
}
 

import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation; //导入依赖的package包/类
@Bean
public RestDocumentationResultHandler restDocumentation() {
	return MockMvcRestDocumentation.document("{method-name}");
}