Java RestDocumentationResultHandler类代码示例

import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler; //导入依赖的package包/类
@Before
public void setUp() {
    this.deviceCertificateServiceMock = mock(DeviceCertificateService.class);
    this.demoServiceMock = mock(DemoService.class);

    DeviceCertificateCtrl sut = new DeviceCertificateCtrl(deviceCertificateServiceMock, demoServiceMock);

    RestDocumentationResultHandler document = document("{method-name}",
            preprocessRequest(prettyPrint()), preprocessResponse(prettyPrint()));

    ApplicationResolver applicationResolver = (appId, apiKey) ->
            Mono.just(new ApplicationEntity() {{
                setAppId("demo");
                setApiKey("demodemodemo");
            }});

    this.mvc = MockMvcBuilders.standaloneSetup(sut)
            .setCustomArgumentResolvers(new ApplicationAuthenticationArgumentResolver(applicationResolver))
            .apply(documentationConfiguration(this.restDocumentation))
            .alwaysDo(document)
            .alwaysDo(print())
            .build();
}
 

import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler; //导入依赖的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.RestDocumentationResultHandler; //导入依赖的package包/类
private void insertUser(User user) throws Exception {
    
    RestDocumentationResultHandler document = documentPrettyPrintReqResp("insertUser");
    
    document.document(
            requestFields(userFields(false)),
            responseFields(userFields(false))
    );
    
    this.mockMvc.perform(post("/api/v1/users")
            .accept(MediaType.APPLICATION_JSON)
            .content(objectMapper.writeValueAsString(user))
            .contentType(MediaType.APPLICATION_JSON))
            .andExpect(status().isOk())
            .andDo(document);
}
 

import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler; //导入依赖的package包/类
private void getUser(UUID userId) throws Exception {
    
    RestDocumentationResultHandler document = documentPrettyPrintReqResp("getUser");
    
    document.document(
            pathParameters(userPathParams()),
            responseFields(userFields(false))
    );
    
    this.mockMvc.perform(get("/api/v1/users/{userId}", userId)
            .contentType(MediaType.APPLICATION_JSON))
            .andExpect(status().isOk())
            .andExpect(jsonPath("userId").isNotEmpty())
            .andExpect(jsonPath("firstName").isNotEmpty())
            .andExpect(jsonPath("lastName").isNotEmpty())
            .andExpect(jsonPath("username").isNotEmpty())
            .andDo(document);
}
 

import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler; //导入依赖的package包/类
private void getUsers() throws Exception {
    
    RestDocumentationResultHandler document = documentPrettyPrintReqResp("getUsers");
    
    document.document(
            pathParameters(
                    parameterWithName("page").description("Page of results"),
                    parameterWithName("size").description("Size of results")
            ),
            responseFields(userFields(true))
    );
    
    this.mockMvc.perform(get("/api/v1/users?page={page}&size={size}", 0, 10)
            .contentType(MediaType.APPLICATION_JSON))
            .andExpect(status().isOk())
            .andExpect(jsonPath("$").isArray())
            .andExpect(jsonPath("[*].userId").isNotEmpty())
            .andExpect(jsonPath("[*].firstName").isNotEmpty())
            .andExpect(jsonPath("[*].lastName").isNotEmpty())
            .andExpect(jsonPath("[*].username").isNotEmpty())
            .andDo(document);
}
 

import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler; //导入依赖的package包/类
private void updateUser(User user) throws Exception {
    
    RestDocumentationResultHandler document = 
            documentPrettyPrintReqResp("updateUser");
    
    document.document(
            pathParameters(userPathParams()),
            requestFields(userFields(false)),
            responseFields(userFields(false))
    );
    this.mockMvc.perform(
            put("/api/v1/users/{userId}", user.getUserId())
            .accept(MediaType.APPLICATION_JSON)
            .content(objectMapper.writeValueAsString(user))
            .contentType(MediaType.APPLICATION_JSON))
            .andExpect(status().isOk())
            .andDo(document);
}
 

import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler; //导入依赖的package包/类
@Bean
@ConfigurationProperties("spring.test.restdocs")
public RestDocsMockMvcBuilderCustomizer restDocumentationConfigurer(
		MockMvcRestDocumentationConfigurer configurer,
		ObjectProvider<RestDocumentationResultHandler> resultHandler) {
	return new RestDocsMockMvcBuilderCustomizer(configurer,
			resultHandler.getIfAvailable());
}
 

import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler; //导入依赖的package包/类
private void deleteUser(UUID userId) throws Exception {
    
    RestDocumentationResultHandler document = 
            documentPrettyPrintReqResp("deleteUser");
            
    document.document(
            pathParameters(userPathParams()),
            responseFields(userFields(false))
    );
    
    this.mockMvc.perform(delete("/api/v1/users/{userId}", userId)
            .contentType(MediaType.APPLICATION_JSON))
            .andExpect(status().isOk())
            .andDo(document);
}
 

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

import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler; //导入依赖的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.RestDocumentationResultHandler; //导入依赖的package包/类
RestDocsMockMvcBuilderCustomizer(MockMvcRestDocumentationConfigurer delegate,
		RestDocumentationResultHandler resultHandler) {
	this.delegate = delegate;
	this.resultHandler = resultHandler;
}
 

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

import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler; //导入依赖的package包/类
protected RestDocumentationResultHandler docHandler() {
	return this.documentationHandler;
}
 

import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler; //导入依赖的package包/类
public RestDocumentationResultHandler documentPrettyPrint( String useCase, Snippet... snippets )
{
    return document( useCase, preprocessRequest( prettyPrint() ), preprocessResponse( prettyPrint() ), snippets );
}
 

import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler; //导入依赖的package包/类
protected RestDocumentationResultHandler commonDocumentation() {
    return document("{class-name}/{method-name}",
            preprocessRequest(), commonResponsePreprocessor());
}