TSK-1533: configured spring-auto-rest-docks JacksonModelAttributeSnippet

in order to automatically generate the documentation for our ModelAttribute request types
This commit is contained in:
Mustapha Zorgati 2021-02-02 21:08:57 +01:00
parent 477470302a
commit 368b3c7d54
1 changed files with 5 additions and 0 deletions

View File

@ -28,6 +28,7 @@ import org.springframework.test.web.servlet.setup.ConfigurableMockMvcBuilder;
import org.springframework.test.web.servlet.setup.MockMvcBuilders; import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.test.web.servlet.setup.MockMvcConfigurerAdapter; import org.springframework.test.web.servlet.setup.MockMvcConfigurerAdapter;
import org.springframework.web.context.WebApplicationContext; import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter;
import pro.taskana.common.test.rest.RestHelper; import pro.taskana.common.test.rest.RestHelper;
import pro.taskana.common.test.rest.TaskanaSpringBootTest; import pro.taskana.common.test.rest.TaskanaSpringBootTest;
@ -39,6 +40,7 @@ public class BaseRestDocTest {
protected MockMvc mockMvc; protected MockMvc mockMvc;
@Autowired protected ObjectMapper objectMapper; @Autowired protected ObjectMapper objectMapper;
@Autowired protected RestHelper restHelper; @Autowired protected RestHelper restHelper;
@Autowired private RequestMappingHandlerAdapter requestMappingHandlerAdapter;
@BeforeEach @BeforeEach
public void setUp( public void setUp(
@ -64,11 +66,14 @@ public class BaseRestDocTest {
AutoDocumentation.requestParameters().failOnUndocumentedParams(true), AutoDocumentation.requestParameters().failOnUndocumentedParams(true),
AutoDocumentation.description(), AutoDocumentation.description(),
AutoDocumentation.methodAndPath(), AutoDocumentation.methodAndPath(),
AutoDocumentation.modelAttribute(
requestMappingHandlerAdapter.getArgumentResolvers()),
AutoDocumentation.sectionBuilder() AutoDocumentation.sectionBuilder()
.snippetNames( .snippetNames(
SnippetRegistry.AUTO_AUTHORIZATION, SnippetRegistry.AUTO_AUTHORIZATION,
SnippetRegistry.AUTO_PATH_PARAMETERS, SnippetRegistry.AUTO_PATH_PARAMETERS,
SnippetRegistry.AUTO_REQUEST_PARAMETERS, SnippetRegistry.AUTO_REQUEST_PARAMETERS,
SnippetRegistry.AUTO_MODELATTRIBUTE,
SnippetRegistry.AUTO_REQUEST_FIELDS, SnippetRegistry.AUTO_REQUEST_FIELDS,
SnippetRegistry.AUTO_RESPONSE_FIELDS, SnippetRegistry.AUTO_RESPONSE_FIELDS,
SnippetRegistry.AUTO_LINKS, SnippetRegistry.AUTO_LINKS,