springboot集成restdocs输出接口文档

1、pom文件新增restdocs

    
org.springframework.restdocs
spring-restdocs-mockmvc    
test

    
org.asciidoctor
asciidoctor-maven-plugin    
1.5.8    
            
             
     generate-docs            
     prepare-package            
                     
  process-asciidoc            
                 
                     
  html                
  book            
             
     
        
        
    
 org.springframework.restdocs
 spring-restdocs-asciidoctor
 ${spring-restdocs.version}
        

2、在test包下新建controller

@RunWith(SpringRunner.class)
@SpringBootTestpublic class ApibaseController {    

    @Rule    
    public JUnitRestdocumentation restdocumentation = new JUnitRestdocumentation();    
    
    public MockMvc mockMvc;    
    
    @Autowired    
    private WebApplicationContext context;    
    
    @Before    
    public void setUp() { 
 this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
      .apply(documentationConfiguration(this.restdocumentation))
      .build();   
    }
}

public class TestController extends ApibaseController {
    @Test    
    public void test() throws Exception  { 
 super.mockMvc.perform(post("/test").param("aaa", "bbb")  
   .contentType(MediaType.APPLICATION_JSON))  
   .andDo(document("{ClassName}/{methodName}", 
   preprocessRequest(prettyPrint()), preprocessResponse(prettyPrint()),   
   requestParameters(parameterWithName("aaa").description("查询名字"))));    
     }
 }

= API:toc: 
left:toclevels: 4
[[order-it]]
== 1. 订单接口
[[order-query]]
=== 订单查询
operation::TestController/test[snippets='curl-request,http-request']